Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ziqiangwang/readmet
A command tool to create standard README.md conveniently.
https://github.com/ziqiangwang/readmet
readme standard template
Last synced: 7 days ago
JSON representation
A command tool to create standard README.md conveniently.
- Host: GitHub
- URL: https://github.com/ziqiangwang/readmet
- Owner: ZiQiangWang
- License: mit
- Created: 2019-01-11T09:24:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-28T15:23:02.000Z (almost 6 years ago)
- Last Synced: 2024-04-29T23:24:06.325Z (8 months ago)
- Topics: readme, standard, template
- Language: JavaScript
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# readmet
[![NPM Version][npm-badge]][npm-url]
[![Downloads Stats][npm-downloads]][npm-url]
[npm-badge]: https://img.shields.io/npm/v/readmet.svg?style=flat-square
[npm-url]: https://npmjs.org/package/readmet
[npm-downloads]: https://img.shields.io/npm/dm/readmet.svg?style=flat-square
> A command tool to create standard README.md conveniently.
## Installation
```sh
npm install -g readmet
```
## Usage
```sh
Usage: readmet [options]
A command tool to create standard README.md conveniently.
Options:
-v, --version output the version number
-r, --repo Create from a remote repo
-l, --list Create from list of remote repos
-i, --init Create from a template
-h, --help Output usage information
```
repo url used with `readmet -r` will be seen in the result of `readmet -l`
## Acknowledgments
Initial repos are from the community:
- [PurpleBooth/README-Template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
- [RichardLitt/standard-readme](https://github.com/RichardLitt/standard-readme)
- [dbader/readme-template](https://github.com/dbader/readme-template)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details