Update README
This commit is contained in:
parent
1bc5ae70d9
commit
bd07ee8022
35
README.md
35
README.md
@ -1,3 +1,38 @@
|
|||||||
# ghup
|
# ghup
|
||||||
|
|
||||||
Simple Github helper for myself.
|
Simple Github helper for myself.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
If you don't have haskell GHC and cabal installed,
|
||||||
|
follow [ghcup](https://www.haskell.org/ghcup/) first.
|
||||||
|
|
||||||
|
Then issue:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ cabal v2-install ghup
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
First you need to set the github OAuth (no other method currently supported)
|
||||||
|
for API access:
|
||||||
|
|
||||||
|
```
|
||||||
|
ghup config --oauth "<your-github-token>"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then follow the help page:
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage: ghup COMMAND
|
||||||
|
|
||||||
|
Available options:
|
||||||
|
-h,--help Show this help text
|
||||||
|
|
||||||
|
Available commands:
|
||||||
|
fork Fork a repository
|
||||||
|
config Set ghup config (such as OAuth)
|
||||||
|
delete Delete a forked repository
|
||||||
|
list-forks List my forks
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user