Update README

This commit is contained in:
Julian Ospald 2020-02-01 00:38:44 +01:00
parent 1bc5ae70d9
commit bd07ee8022
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28

View File

@ -1,3 +1,38 @@
# ghup
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
```