https://github.com/tiagodanin/gen-readme
Generate a README.md from package.json contents. [Fork https://github.com/zeke/package-json-to-readme/]
https://github.com/tiagodanin/gen-readme
generator github hacktoberfest npm package-json package-manager readme
Last synced: 6 months ago
JSON representation
Generate a README.md from package.json contents. [Fork https://github.com/zeke/package-json-to-readme/]
- Host: GitHub
- URL: https://github.com/tiagodanin/gen-readme
- Owner: TiagoDanin
- License: mit
- Created: 2019-01-02T23:57:32.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T14:53:53.000Z (7 months ago)
- Last Synced: 2025-04-13T02:13:23.411Z (6 months ago)
- Topics: generator, github, hacktoberfest, npm, package-json, package-manager, readme
- Language: JavaScript
- Homepage:
- Size: 440 KB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gen README
[](https://travis-ci.org/TiagoDanin/Gen-README) [](https://npmjs.org/package/gen-readme) [](https://npmjs.org/package/gen-readme) [](https://npmjs.org/package/gen-readme) [](https//github.com/zeke/package-json-to-readme) [](https://github.com/xojs/xo)
Generate a README.md from package.json contents.
## Features
- Automate and improve your readme
- Awesome badges (Travis CI, XO, NPM Download...)
- List dependencies
- Load documentation
- Sort dependencies, badges and others keys
- Screenshot
## Installation
Module available through the [npm registry](https://www.npmjs.com/). It can be installed using the [`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) or [`yarn`](https://yarnpkg.com/en/) command line tool.
```sh
# Yarn (Recomend)
yarn global add gen-readme
# NPM
npm install gen-readme --global
```
## Usage
```sh
# Show help
gen-readme --help
# Write to stdout
gen-readme package.json
# Pipe output into a new file
gen-readme package.json > README.md
# Add a Travis badge (if not exit .travis.yml)
gen-readme package.json --travis
# Output in README.md
gen-readme package.json --write
# Disable default badges
gen-readme package.json --no-badges
```
## Example
```js
dsa
```
## Tests
To run the test suite, first install the dependencies, then run `test`:
```sh
# Using Yarn
yarn test
```
## Dependencies
debug: small debugging utility
Author: TJ Holowaychuk
License: MIT
Version: ^4.1.1
github-url-to-object: Extract user, repo, and other interesting properties from GitHub URLs
Author: zeke
License: MIT
Version: ^4.0.4
handlebars: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration
Author: Yehuda Katz
License: MIT
Version: ^4.7.6
locate-path: Get the first path that exists on disk of multiple paths
Author: Sindre Sorhus
License: MIT
Version: ^5.0.0
lodash: Lodash modular utilities.
Author: John-David Dalton
License: MIT
Version: ^4.17.15
meow: CLI app helper
Author: Sindre Sorhus
License: MIT
Version: ^7.0.1
package-info: Get the information of a npm package
Author: Alessandro Minoccheri
License: MIT
Version: ^3.0.2
upath: A proxy to `path`, replacing `\` with `/` for all results & new methods to normalize & join keeping leading `./` and add, change, default, trim file extensions.
Author: Angelos Pikoulas
License: MIT
Version: ^1.2.0
update-notifier: Update notifications for your CLI app
Author: Sindre Sorhus
License: BSD-2-Clause
Version: ^4.1.0
## Dev Dependency
xo: JavaScript/TypeScript linter with great defaults
Author: Sindre Sorhus
License: MIT
Version: ^0.30.0
## Related
package-json-to-readme: Generate a README.md from package.json contents
Author: Zeke Sikelianos
License: MIT
gen-package: Intuitive and user-friendly generator of package.json
Author: TiagoDanin
License: MIT
## Contributors
Pull requests and stars are always welcome. For bugs and feature requests, please [create an issue](https://github.com/TiagoDanin/Gen-README/issues). [List of all contributors](https://github.com/TiagoDanin/Gen-README/graphs/contributors).
## Thanks
- [zeke](https://github.com/zeke/package-json-to-readme/): Gen README is an fork of https://github.com/zeke/package-json-to-readme/
## License
[MIT](LICENSE) © [Tiago Danin](https://TiagoDanin.github.io)