Permalink
Browse files

Adds License and cleans up readme

  • Loading branch information...
1 parent 7093876 commit 460f2576e0f6d5410c55f6450a2656ebc460096c @nesquena committed Dec 1, 2011
Showing with 49 additions and 20 deletions.
  1. +20 −0 LICENSE
  2. +29 −20 README.md
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2011 GoMiso, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -12,58 +12,67 @@ Install the gem:
gem install gitdocs
```
-If you have Growl installed, you'll probably want to run `brew install growlnotify` to enable Growl support.
+If you have Growl installed on Max OSX, you'll probably want to run:
+
+```
+brew install growlnotify
+```
+
+to enable Growl support (other platforms coming soon).
## Usage
-First add the doc folders to watch:
+Gitdocs is centered around 'watching' any number of directories for changes and keeping them automatically synced. You can either add
+existing git directories for monitoring or have gitdocs pull down a repository to monitor.
+
+You can add existing folders to watch:
```
gitdocs add my/path/to/watch
```
-You can remove and clear paths as well:
+or instruct gitdocs to fetch a remote repository and keep it synced with:
```
-gitdocs rm my/path/to/watch
-# or gitdocs clear
+gitdocs create local/path/for/repo git@github.com:user/some/remote/repo.git
```
-You need to startup gitdocs:
+This will clone the remote repo and begin monitoring the local path. You can remove and clear monitored paths as well:
```
-gitdocs start
+gitdocs rm my/path/to/watch
+gitdocs clear
```
-If the start command doesn't seem to properly start the process, you can run with a debug flag:
+You need to start gitdocs in order for the monitoring to work:
```
-gitdocs start -D
+gitdocs start
```
-You can also `stop` and `restart` gitdocs as needed. Run
+If the start command fails, you can run again with a debug flag:
```
-gitdocs status
+gitdocs start -D
```
-for a helpful listing of the current state. Once gitdocs is started, simply start editing or adding files to your
-designated git repository. Changes will be automatically pushed and pulled to your local repo.
-
-You can also have gitdocs fetch a remote repository with:
+and gitdocs can be easily stopped and restarted:
```
-gitdocs create my/path/for/doc git@github.com:user/some_docs.git
+gitdocs stop
+gitdocs restart
```
-This will clone the repo and add the path to your watched docs. Be sure to restart gitdocs
-to have path changes update:
+For an overview of gitdocs current status, run:
```
-gitdocs restart
+gitdocs status
```
-To view the docs in your browser with file formatting:
+Once gitdocs has been started and is monitoring the correct directories, simply start editing or adding files to your
+designated git repos. Changes will be automatically pushed and pulled to your local repos.
+
+To explore the repos in your browser, simply start the server:
```
gitdocs serve

0 comments on commit 460f257

Please sign in to comment.