Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 7 days 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 6 years ago)
Default Branch: master
Last Pushed: 2024-10-03T19:38:00.000Z (about 1 month ago)
Last Synced: 2024-10-23T12:54:36.766Z (15 days ago)
Topics: generator, github, hacktoberfest, npm, package-json, package-manager, readme
Language: JavaScript
Homepage:
Size: 438 KB
Stars: 11
Watchers: 3
Forks: 3
Open Issues: 24
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Gen README

[![Travis](https://img.shields.io/travis/TiagoDanin/Gen-README.svg?branch=master&style=flat-square)](https://travis-ci.org/TiagoDanin/Gen-README) [![Downloads](https://img.shields.io/npm/dt/gen-readme.svg?style=flat-square)](https://npmjs.org/package/gen-readme) [![Node](https://img.shields.io/node/v/gen-readme.svg?style=flat-square)](https://npmjs.org/package/gen-readme) [![Version](https://img.shields.io/npm/v/gen-readme.svg?style=flat-square)](https://npmjs.org/package/gen-readme) [![Fork](https://img.shields.io/badge/Fork-Package%20Json%20To%20Readme-blue.svg?style=flat-square)](https//github.com/zeke/package-json-to-readme) [![XO code style](https://img.shields.io/badge/code%20style-XO-red.svg?style=flat-square)](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)