diff --git a/README.md b/README.md index 0f69a2a..73d0f3d 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ # BetterMOTD +Description? Pictures say more than words! +## screenshot: +![alt text](https://cz0.cz/static/untracked/images/bm_demo.png "Example of BetterMOTD at work") +## quick install: +``` +https://cz0.cz/git/czoczo/BetterMOTD.git +``` +## usage: +``` +./bmotd.sh +Use: ./bmotd.sh [ test | update | enable | disable ] + + test - Print generated motd to standard output. Use for preview. + update - Update /etc/motd file + enable - Places ./bmotd.sh in /etc and adds cron entry for script to run every minute + disable - Removes cron entry and disables refreshes of /etc/motd +```