Markdown credits for JavaScript projects. Mentions direct contributors, dependency licenses and anything else you want to add.
Supports All Contributors!
$ cd my-project
$ # install dependencies
$ npm install
$ # or if you only want to mention production dependencies
$ npm install --production
$ # generate the report
$ npx credit-roll > credits.mdExample:
<!-- This document was automatically generated through `credit-roll`. Please don't edit it directly. -->
# Credits
This project is made possible by the community surrounding it and especially the wonderful people and projects listed in this document.
## Contributors
- [Julian Gruber](https://github.com/juliangruber)
## Libraries
### [picomatch](https://ghub.io/picomatch)
<details>
<summary>MIT</summary>
The MIT License (MIT)
</details>
Several different sections are supported.
If an .all-contributorsrc is present, add a Contributors section and link to their respective GitHub profiles.
For every extra json file passed, add a section listing the names mentioned.
For example, to add a ## Testers, section, create a file testers.json:
[{ "name": "A robot" }, { "name": "Beep Boop" }]and pass it like this:
$ npx credit-roll ./testers.json > credits.mdThe resulting markdown will be:
...
## Testers
- A robot
- Beep Boop
...
The section name is deducted from the file name.
For each library found in ./node_modules, add name, license name and license text.
In order to keep your credits.md up to date, check out this GitHub Action: https://github.com/hypergraph-xyz/desktop/blob/main/.github/workflows/credits.yml.
Below is the credit-roll output for this project (only production dependencies, for brevity). Check credits.md for a full example.
This project is made possible by the community surrounding it and especially the wonderful people and projects listed in this document.
MIT
The MIT License (MIT)
Copyright (c) 2017-present, Jon Schlinkert.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
MIT
MIT License
Copyright (c) 2012-2019 Thorsten Lorenz, Paul Miller (https://paulmillr.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Thanks goes to these wonderful people (emoji key):
 Julian Gruber 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!