CLI for scaffolding a README
$ npm i -g create-readme-cliSimply run create-readme followed by any options and answer the prompts to create a README.md in your current directory. See this README for an example of what will be generated.
$ create-readme --badges --browsers| CLI argument | Description |
|---|---|
--bmc |
Enables prompt for Buy Me a Coffee link |
--badges |
Enables prompt for shields badges |
--browsers |
Enables prompt for browser compatibility table |
This project is open to and encourages contributions! Feel free to discuss any bug fixes/features in the issues. If you wish to work on this project:
- Fork this project
- Create a branch (`git checkout -b new-branch`)
- Commit your changes (`git commit -am 'add new feature'`)
- Push to the branch (`git push origin new-branch`)
- Submit a pull request!