Skip to content

Commit 9afe123

Browse files
committed
Adding the info on the API key setup
1 parent 0694dab commit 9afe123

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README-setup.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Tutorial
2+
3+
## Setup
4+
5+
- Is usually run on Github Actions
6+
- Can be run locally, see `run.sh` for plain R, or `render.sh` using Docker
7+
- If run locally, a `.Renviron` file is needed with the requisite API key.
8+
9+
## API keys
10+
11+
Read the tutorial (natch) and get an API key.
12+
13+
## Setting up the API key for Github
14+
15+
Edit the `.Renviron` file, then set the API key using the `gh` command line tool:
16+
17+
```
18+
gh secret set -f .Renviron
19+
```
20+
21+
then check that they were actually set:
22+
23+
```
24+
gh secret list
25+
```
26+
27+

0 commit comments

Comments
 (0)