Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mdluo committed Aug 15, 2020
1 parent 99c1783 commit d300075
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@

### Prep work

1. Create a new public GitHub Gist (https://gist.github.com/), you can type any random content as placeholder, it will be replaced automatically.
1. Create a token with the `gist` scope and copy it (https://github.com/settings/tokens/new?scopes=gist&description=goodreads-box).
1. Create a Goodreads account (https://www.goodreads.com/user/sign_in).
1. Create Goodreads App and copy the Api Key (https://www.goodreads.com/api/keys).
1. Create a Goodreads account ([goodreads.com/user/sign_in](https://www.goodreads.com/user/sign_in)).
1. Create Goodreads App and copy the Api Key ([goodreads.com/api/keys](https://www.goodreads.com/api/keys)).
1. Create a new personal access token with the `gist` scope and copy it ([github.com/settings/tokens/new](https://github.com/settings/tokens/new?scopes=gist&description=goodreads-box)).
1. Create a new public GitHub Gist ([gist.github.com](https://gist.github.com/)), you can type any random content as placeholder, it will be replaced automatically.

### Project setup

1. Fork this repo.
1. Go to the repo Settings > Secrets.
1. Add the following environment variables:
- **GOODREADS_API_KEY**: The Goodreads App Api Key.
- **GOODREADS_USER_ID**: Your Goodreads account id, can be found in the profile page url e.g. `https://www.goodreads.com/user/show/`**118339107**`-mdluo`
- **GOODREADS_USER_ID**: Your Goodreads account id, can be found in the profile page url e.g. `https://www.goodreads.com/user/show/`**`118339107`**`-mdluo`
- **BOOKS_SORT_BY**: Optional, default value is `date` which means sort books by update time. Another valid value is `percent`, sort book by read percentage.
- **GH_TOKEN**: The GitHub token generated above.
- **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/mdluo/`**`f890a4d178012c5a3c5c29ff743a84e8`**.
- **GH_TOKEN**: The GitHub personal access token generated above.
- **GIST_ID:** The ID portion from your new created gist url: `https://gist.github.com/mdluo/`**`f890a4d178012c5a3c5c29ff743a84e8`**.

0 comments on commit d300075

Please sign in to comment.