rob
/
noprocrast
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update README

This commit is contained in:
Rob Watson 2010-11-10 15:13:34 +00:00
parent de686f0c79
commit 720ef11f60
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.rdoc
View File

@ -1,17 +1,26 @@
= noprocast = 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 = Installation
* Fork the project. <tt>gem install noprocast</tt>
* 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.
== Copyright = Usage
<tt>noprocast status</tt> check if noprocast is enabled or not
<tt>noprocast edit</tt> edit noprocast's list of banned websites
<tt>[sudo] noprocast on</tt> enable noprocast
<tt>[sudo] noprocast off</tt> 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.