From 720ef11f6019dd608ddd7e471149eec2d7ef6a51 Mon Sep 17 00:00:00 2001 From: Rob Watson Date: Wed, 10 Nov 2010 15:13:34 +0000 Subject: [PATCH] update README --- README.rdoc | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.rdoc b/README.rdoc index 0903b1c..20cbace 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,17 +1,26 @@ = noprocast -Description goes here. +A gem to stop you procastinating. Noprocast automatically adds and removes items from your /etc/hosts, rendering addictive websites useless. -== Note on Patches/Pull Requests - -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. += Installation -== Copyright +gem install noprocast + += Usage + +noprocast status check if noprocast is enabled or not + +noprocast edit edit noprocast's list of banned websites + +[sudo] noprocast on enable noprocast + +[sudo] noprocast off disable noprocast + += Notes + +Noprocast saves a backup of your /etc/hosts file in /etc/.hosts.noprocastbackup the first time it runs. Just in case. + += Contact + +rfwatson at gmail -Copyright (c) 2010 Rob Watson. See LICENSE for details.