gitdocs 0.1.4 → 0.1.5

data/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.

data/README.md

@@ -2,8 +2,7 @@
 
 Collaborate on files and docs through a shared git repository. gitdocs will automatically push changes to the repo as well as pull in changes.
 This allows any git repo to be used as a collaborative task list or wiki for a team.
-
-You can also start a web front-end allowing the repo to be viewed through the browser.
+You can also start a web front-end allowing the repo to be accessed through a browser.
 
 ## Installation
 
@@ -13,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
@@ -74,8 +82,23 @@ and then visit `http://localhost:8888` for access to all your docs in the browse
 
 ## Planned Features
 
- - A web UI for uploading, and editing text files (in addition to viewing)
- - Local-area peer-to-peer sync.
- - Click-to-share instant access granting.
- - Better conflict-resolution behavior (maintains both versions of a file)
- - Support for linux and windows (coming soon)
+Gitdocs is a young project but we have big plans for it including:
+
+ - A web front-end UI for file uploading and editing of files (with rich text editor and syntax highlighting)
+ - Local-area peer-to-peer syncing, avoid 'polling' in cases where we can using a messaging protocol.
+ - Click-to-share instant access granting file access to users using a local tunnel or other means.
+ - Better conflict-resolution behavior on updates (maintain both versions of a file)
+ - Support for linux and windows platforms (coming soon), and maybe android and iOS as well?
+
+## Prior Projects
+
+Gitdocs is a fresh project that we spiked on in a few days time. Our primary goals are to keep the code as simple as possible,
+but provide the features that makes dropbox great. If you are interested in other Dropbox alternatives, be sure to checkout our notes below:
+
+ * [SparkleShare](http://sparkleshare.org/) is an open source, self-hosted Dropbox alternative. Nice project and a great alternative but has a lot of dependencies,
+   more complex codebase, and lacks some of the features we have planned for gitdocs in the near future.
+ * [DVCS-Autosync](http://mayrhofer.eu.org/dvcs-autosync) is a project to create an open source replacement for Dropbox based on distributed version control systems.
+   Very similar project but again we have features planned that are out of scope (local tunnel file sharing, complete web ui for browsing, uploading and editing).
+ * [Lipsync](https://github.com/philcryer/lipsync) is another similar project. We haven't looked at this too closely, but thought we would mention it in this list.
+
+If any other open-source dropbox alternatives are available, we would love to hear about them so let us know!

data/lib/gitdocs/runner.rb

@@ -134,8 +134,8 @@ module Gitdocs
     def sh_with_code(cmd)
       cmd << " 2>&1"
       outbuf = ''
-      outbuf = `cd #{@root} && #{cmd}`
+      outbuf = `cd "#{@root}" && #{cmd}`
       [outbuf, $?]
     end
   end
-end
+end

data/lib/gitdocs/version.rb

@@ -1,3 +1,3 @@
 module Gitdocs
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -2,7 +2,7 @@
 name: gitdocs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Josh Hull
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-30 00:00:00 -08:00
+date: 2011-12-01 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/gitdocs