readme-author
v0.1.6
Published
Zero-config CLI tool to auto-generate README.md from your project
Maintainers
Readme
readme-author
Zero-config CLI tool to auto-generate README.md from your project
Table of Contents
- Overview
- Getting Started
- Available Scripts
- Project Structure
- Dependencies
- Configuration
- Contributing
- License
Overview
Zero-config CLI tool to auto-generate README.md from your project
Getting Started
Prerequisites
- Node.js 18+
- npm
Installation
npm install
Run
npm run buildAvailable Scripts
| Script | Command |
| --- | --- |
| build | npm run build |
Project Structure
.
├── public/
│ └── images/
│ └── mvp.png
├── scripts/
├── src/
│ ├── core/
│ │ ├── package-parser.ts
│ │ └── stack-detector.ts
│ ├── generator/
│ │ └── markdown-generator.ts
│ └── cli.ts
├── .gitignore
├── package-lock.json
├── package.json
├── README.md
└── tsconfig.jsonDependencies
- Runtime dependencies: 6
- Development dependencies: 5
Runtime
chalkcommanderfigletfs-extragradient-stringora
Development
@types/figlet@types/gradient-string@types/nodets-nodetypescript
Configuration
- Keywords:
cli,readme,documentation,nodejs,developer-tools - Repository: https://github.com/tallman1O/readme-author.git
- Author: Mehul Uttam
- Version: 0.1.5
Contributing
Contributions are welcome. Please open an issue first to discuss any major change.
License
Licensed under the ISC license.
