Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
ghalib committed Oct 10, 2013
1 parent 5915880 commit 3fcfbac
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
gitsync
gitsync (BETA)
=======

Git repository syncronisation daemon
gitsync is a repository-syncronisation daemon, whose purpose is to
keep coders on the same project aware of each others' work without
requiring any pushes to remotes. Running on machines on the same local
network, on any given peer it will auto-fetch any branches modified on
the other peers.

For example, say Alice and Bob are working on repo 'foo' on their
separate machines. With gitsyncd running on both machines, everytime
Alice makes a local commit, Bob's machine will auto-fetch Alice's
modified branch into a local one named `gitsync-Alice-branch`.

Run with `gitsyncd /path/to/repo`.

You can open up a local webserver to see a live-updating page of your
coworker's changes by suppling a port number: `gitsyncd /path/to/repo
port`.

See extended options by running `gitsyncd -h`.

0 comments on commit 3fcfbac

Please sign in to comment.