mirror of
https://github.com/kennethreitz/ghsync.git
synced 2026-06-05 23:10:16 +00:00
documentation update
This commit is contained in:
+22
-6
@@ -1,9 +1,10 @@
|
||||
ghsync: GitHub Repo Syncer
|
||||
==========================
|
||||
|
||||
This script uses the GitHub API to get a list of all forked, mirrored, public, and
|
||||
private repos in your GitHub account. If the repo already exists locally, it will
|
||||
update it via git-pull. Otherwise, it will properly clone the repo.
|
||||
This script uses the GitHub API to get a list of all forked, mirrored,
|
||||
public, and private repos in your GitHub account. If the repo already
|
||||
exists locally, it will update it via git-pull. Otherwise, it will
|
||||
properly clone the repo.
|
||||
|
||||
It will organize your repos into the following directory structure: ::
|
||||
|
||||
@@ -26,16 +27,31 @@ Install
|
||||
To install ghsync, simply run: ::
|
||||
|
||||
$ pip install ghsync
|
||||
|
||||
The command ``ghsync`` will then be available to you from the command line. Beware, unless you set the ``GHSYNC_DIR`` environment variable, it will add all the repos to your current directory.::
|
||||
|
||||
The command ``ghsync`` will then be available to you from the command
|
||||
line. Beware, unless you set the ``GHSYNC_DIR`` environment variable, it
|
||||
will add all the repos to your current directory.::
|
||||
|
||||
$ export GHSYNC_DIR='~/repos/'
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
If the ``--upsteam`` argument is passed, all forked repos will have an
|
||||
**upstream** remote added, pointing to their parent repo on GitHub.
|
||||
|
||||
You can also selectively sync certian types of repos with ``--only``. If
|
||||
you'd like to only sync forked repositories, for example::
|
||||
|
||||
$ ghsync --only forks
|
||||
|
||||
|
||||
Contribute
|
||||
----------
|
||||
|
||||
If you'd like to contribute, simply fork `the repository`_, commit your changes to the **develop** branch (or branch off of it), and send a pull request.
|
||||
If you'd like to contribute, simply fork `the repository`_, commit your
|
||||
changes to the **develop** branch (or branch off of it), and send a pull
|
||||
request.
|
||||
|
||||
|
||||
.. _`the repository`: http://github.com/kennethreitz/ghsync
|
||||
|
||||
Reference in New Issue
Block a user