Skip to content

Commit

Permalink
add more commandline options, infos about the (planed) workflow and f…
Browse files Browse the repository at this point in the history
…urther TODOs
  • Loading branch information
engeld committed Nov 7, 2013
1 parent 167a994 commit b55b355
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,20 @@ $ chmod +x ./fetch-stars.sh
How to use
----------

./fetch-stars.sh
./fetch-stars.sh [-u USER] [-d DIRECTORY]

*If you have two-factor-auth enabled (like myself):*
- create a "Personal Access Token" on [this settings page](https://github.com/settings/applications)
- use the created "Personal Access Token" as username
- use 'x-oauth-basic' as password

Workflow
--------
- Loop through all of the given users starred projects
- For each one, check if it already exists in the target directory
- If it doesn't exists yet, clone it there
- If it already exists, update it


Known Issues
------------
Expand All @@ -37,8 +44,10 @@ Known Issues

TODO
----
- Implement Sync
- Full OAUTH/GitHub-Auth support
- Few more commandline-switches
- USE GETOPTS

Resources & Co
--------------
Expand Down

0 comments on commit b55b355

Please sign in to comment.