README.md in gitdocs-0.4.0 vs README.md in gitdocs-0.4.1

- old
+ new

@@ -57,31 +57,10 @@ to enable Growl support (other platforms coming soon). ## Usage -### Monitoring Shares - -You can add existing folders to watch: - -``` -gitdocs add my/path/to/watch -``` - -or instruct gitdocs to fetch a remote share and keep it synced with: - -``` -gitdocs create local/path/for/repo git@github.com:user/some/remote/repo.git -``` - -This will clone the remote repo and begin monitoring the local path. You can remove and clear monitored paths as well: - -``` -gitdocs rm my/path/to/watch -gitdocs clear -``` - ### Starting Gitdocs You need to start gitdocs in order for the monitoring to work: ``` @@ -105,34 +84,68 @@ For an overview of gitdocs current status, run: ``` gitdocs status ``` -### Conflict Resolution -Proper conflict resolution is an important part of any good doc and file collaboration tool. -In most cases, git does a good job of handling file merges for you. Still, what about cases where the conflict cannot be -resolved automatically? +### Monitoring Shares -Don't worry, gitdocs makes handling this simple. In the event of a conflict, **all the different versions -of a document are stored** in the repo tagged with the **git sha** for the commit for each variation. The members -of the repo can then compare all versions and resolve the conflict. +You can add existing folders to watch: +``` +gitdocs add my/path/to/watch +``` + +or instruct gitdocs to fetch a remote share and keep it synced with: + +``` +gitdocs create local/path/for/repo git@github.com:user/some/remote/repo.git +``` + +This will clone the remote repo and begin monitoring the local path. You can remove and clear monitored paths as well: + +``` +gitdocs rm my/path/to/watch +gitdocs clear +``` + ### Web Front-end -Gitdocs come with a handy web front-end that is available. This browser front-end supports the following features: +Gitdocs come with a handy web front-end that is available. +<a href="http://i.imgur.com/IMwqN.png"> + <img src="http://i.imgur.com/IMwqN.png" width="250" /> +</a> +<a href="http://i.imgur.com/0wVyB.png"> + <img src="http://i.imgur.com/0wVyB.png" width="250" /> +</a> +<a href="http://i.imgur.com/Ijyo9.png"> + <img src="http://i.imgur.com/Ijyo9.png" width="250" /> +</a> + +This browser front-end supports the following features: + * Explore the files within all your shares * View source files in your shares with code syntax highlighting * View text files in your shares with smart formatting (markdown, textile) * View any file in your shares that can be rendered inline (pdf, images, et al) * Edit and update text files using a text editor * Upload and create new files within your shares * Manage share settings and other configuration options To check out the front-end, simply visit `http://localhost:8888` whenever gitdocs is running. +### Conflict Resolution + +Proper conflict resolution is an important part of any good doc and file collaboration tool. +In most cases, git does a good job of handling file merges for you. Still, what about cases where the conflict cannot be +resolved automatically? + +Don't worry, gitdocs makes handling this simple. In the event of a conflict, +**all the different versions of a document are stored** in the repo tagged with the **git sha** for each +committed version. The members of the repo can then compare all versions and resolve the conflict. + ## Planned Features Gitdocs is a young project but we have big plans for it including: - Click-to-share instant access granting file access to users using a local tunnel or other means. @@ -143,11 +156,11 @@ ## 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, - and lacks some of the features we have planned for gitdocs in the near future. More mature project, so be sure to take a look. + * [SparkleShare](http://sparkleshare.org/) is an open source, self-hosted Dropbox alternative written using C# and the [Mono Project](http://www.mono-project.com/Main_Page). + More mature but has a lot of dependencies, and lacks some of the features planned in Gitdocs. * [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. * [bitpocket](https://github.com/sickill/bitpocket) is a project that uses rsync to synchronize data. Interesting concept, but lacks revision history, author tracking, etc and we have features planned that are out of scope for this project