mirrors/all-contributors-cli
1
0
Fork 0
mirror of https://github.com/all-contributors/cli.git synced 2025-01-09 13:36:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove TODOs from README where implemented

Browse source
This commit is contained in:
Jeroen Engels 2016-02-29 12:11:23 +01:00
parent 4066516ba4
commit d44ac1a21f
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -53,8 +53,8 @@ or creating a `all-contributors` updating the `package.json` file:
```
These are the keys you can specify:
- TODO `file`: File to write the list of contributors in. Default: 'README.md'
- TODO `owner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributor-cli` --> `jfmengels`. By default will be parsed from the repo's homepage in `package.json`.
- TODO `project`: Name of the project. Default: Name of the project written in the `package.json` file.
- TODO `imageSize`: Size (in px) of the user's avatar. Default: 100.
- TODO `emoji`: Specify custom emoji, can override the existing override.
- `file`: File to write the list of contributors in. Default: 'README.md'
- `owner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributor-cli` --> `jfmengels`. By default will be parsed from the repo's homepage in `package.json` (TODO).
- `project`: Name of the project. Default: Name of the project written in the `package.json` file (TODO).
- `imageSize`: Size (in px) of the user's avatar. Default: 100.
- `emoji`: Specify custom emoji, can override the documented emojis.