README.md in git_ocd-0.1.1 vs README.md in git_ocd-0.1.2
- old
+ new
@@ -1,25 +1,25 @@
# GitOcd
-TODO: Write a gem description
+GitOCD watches a git repo for changes and automatically commits/pushes those changes.
-## Installation
+GitOCD is a terrible idea, well-executed. Have you every wanted your local repo to stay in sync with a remote repo, but you found the whole 'git add', 'git commit', 'git push' cycle was wearing you out? Simply run `git_ocd repo_path` and anytime you save a file in the repo, it'll automatically add, commit, and push the changes.
-Add this line to your application's Gemfile:
+**What could possibly go wrong?** :)
- gem 'git_ocd'
+## Installation
-And then execute:
+To install, just run:
- $ bundle
+ gem install git_ocd
-Or install it yourself as:
+## Usage
- $ gem install git_ocd
+To use, just run:
-## Usage
+ $ git_ocd some_path
-TODO: Write usage instructions here
+To see options (such as delay timing), just run `git_ocd --help`.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)