Skip to content

Commit 564aff7

Browse files
committed
docs: update README with usage instructions and required secrets for APICURON action
1 parent 2dffcc9 commit 564aff7

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# APICURON commit reporter
22

33
A GitHub Action that reports pushes to your repository to APICURON, associating them with user ORCIDs
4+
5+
## Usage
6+
### Setup
7+
8+
1. **Add Secrets to Repository**:
9+
- Go to Repository Settings → Secrets → Actions
10+
- Add these required secrets:
11+
- `REPORT_API_ENDPOINT`: APICURON report API URL
12+
- `REPORT_API_TOKEN`: APICURON API auth token
13+
- `USER_INFO_SERVICE_ENDPOINT`: ORCID lookup service URL
14+
- `USER_INFO_SERVICE_TOKEN`: ORCID service auth token

0 commit comments

Comments
 (0)