k2bd/advent-readme-stars
Automatically update a README with an up-to-date table of your advent of code progress.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| userId | AoC user ID. See the README for instructions on getting this. | yes | — |
| sessionCookie | AoC session cookie - make sure to keep this in a repo secret! See the README for instructions on getting this. | yes | — |
| leaderboardId | AoC leaderboard ID. See the README for instructions on getting this. | no | "" |
| tableMarker | Unique text marking where the stars board section should go. Should be a comment, i.e. <!--- text enclosed in these markers --->, which is not used elsewhere in the README, and which should appear alone on its own line. | no | <!--- advent_readme_stars table ---> |
| starSymbol | Symbol to use in the stars table | no | ⭐ |
| year | Year to post the table for. Defaults to the year of the most recent December | no | "" |
| headerPrefix | Prefix to use for the header before the table, e.g. "##" | no | ## |
| readmeLocation | Location of the README file | no | README.md |
Outputs
no outputs