https://github.com/wolfchamane/amjs-create-readme
Allows to create the README.md file of a project
https://github.com/wolfchamane/amjs-create-readme
documentation module nodejs readme tool
Last synced: about 2 months ago
JSON representation
Allows to create the README.md file of a project
- Host: GitHub
- URL: https://github.com/wolfchamane/amjs-create-readme
- Owner: Wolfchamane
- License: mit
- Created: 2019-07-01T13:18:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T16:02:57.000Z (over 3 years ago)
- Last Synced: 2025-03-16T04:42:07.939Z (about 1 year ago)
- Topics: documentation, module, nodejs, readme, tool
- Language: JavaScript
- Size: 8.52 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @amjs/create-readme 0.1.4
> Allows to create the README.md file of a project
## Installation
```bash
$ npm i @amjs/create-readme
```
## Usage
Declare an additional script in your `package.json` file:
```json
{
"scripts": {
"doc": "node node_modules/@amjs/create-index"
}
}
```
| Options | Description |
|:---:|:--- |
| `--d`, `-docs`, `-partials` | Additional [Handlebars]() templates to add into README file |