Skip to content

Commit 82824f5

Browse files
author
HR
committed
Add installation docs
1 parent 36e857a commit 82824f5

2 files changed

Lines changed: 25 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,31 @@ The GitHub API imposes a [rate limiting](https://developer.github.com/v3/#rate-l
99
To clone private repositories you need to supply an _OAuth token_ for an account with access to the private repository (to get one see https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
1010

1111
# Installation
12-
12+
Install the script via the `pip`:
13+
```
14+
pip install -e git+git://github.com/HR/github-clone#egg=ghclone
15+
```
16+
or via `pipsi`:
17+
```
18+
pipsi install -e git+git://github.com/HR/github-clone#egg=ghclone
19+
```
20+
Uses Python 3.3+
1321

1422
# Usage
1523
```
1624
GitHub clone (git.io/ghclone)
1725
1826
Usage:
19-
ghclone.py <url> [-t | --token=<token>]
20-
ghclone.py (-h | --help)
21-
ghclone.py (-v | --version)
27+
ghclone <url> [-t | --token=<token>]
28+
ghclone (-h | --help)
29+
ghclone (-v | --version)
2230
2331
Examples:
24-
ghclone.py https://github.com/HR/Crypter/tree/master/app
25-
ghclone.py https://github.com/HR/Crypter/tree/dev/app
26-
ghclone.py https://github.com/HR/Crypter/tree/v3.1.0/build
27-
ghclone.py https://github.com/HR/Crypter/tree/cbee54dd720bb8aaa3a2111fcec667ca5f700510/build
28-
ghclone.py https://github.com/HR/Picturesque/tree/master/app/src -t li50d67757gm20556d53f08126215725a698560b
32+
ghclone https://github.com/HR/Crypter/tree/master/app
33+
ghclone https://github.com/HR/Crypter/tree/dev/app
34+
ghclone https://github.com/HR/Crypter/tree/v3.1.0/build
35+
ghclone https://github.com/HR/Crypter/tree/cbee54dd720bb8aaa3a2111fcec667ca5f700510/build
36+
ghclone https://github.com/HR/Picturesque/tree/master/app/src -t li50d67757gm20556d53f08126215725a698560b
2937
3038
Options:
3139
-h --help Show this screen.

ghclone.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
GitHub clone (git.io/ghclone)
55
66
Usage:
7-
ghclone.py <url> [-t | --token=<token>]
8-
ghclone.py (-h | --help)
9-
ghclone.py (-v | --version)
7+
ghclone <url> [-t | --token=<token>]
8+
ghclone (-h | --help)
9+
ghclone (-v | --version)
1010
1111
Examples:
12-
ghclone.py https://github.com/HR/Crypter/tree/master/app
13-
ghclone.py https://github.com/HR/Crypter/tree/dev/app
14-
ghclone.py https://github.com/HR/Crypter/tree/v3.1.0/build
15-
ghclone.py https://github.com/HR/Crypter/tree/cbee54dd720bb8aaa3a2111fcec667ca5f700510/build
16-
ghclone.py https://github.com/HR/Picturesque/tree/master/app/src -t li50d67757gm20556d53f08126215725a698560b
12+
ghclone https://github.com/HR/Crypter/tree/master/app
13+
ghclone https://github.com/HR/Crypter/tree/dev/app
14+
ghclone https://github.com/HR/Crypter/tree/v3.1.0/build
15+
ghclone https://github.com/HR/Crypter/tree/cbee54dd720bb8aaa3a2111fcec667ca5f700510/build
16+
ghclone https://github.com/HR/Picturesque/tree/master/app/src -t li50d67757gm20556d53f08126215725a698560b
1717
1818
Options:
1919
-h --help Show this screen.

0 commit comments

Comments
 (0)