https://github.com/endykaufman/schematics-readme

Generator README.md file for Angular Schematics collection
https://github.com/endykaufman/schematics-readme

angular cli console generator info input library nx oclif react readme schematics tools vue

Last synced: about 2 months ago
JSON representation

Generator README.md file for Angular Schematics collection

• Host: GitHub
• URL: https://github.com/endykaufman/schematics-readme
• Owner: EndyKaufman
• License: mit
• Created: 2019-04-14T19:23:16.000Z (almost 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-02-03T04:08:34.000Z (12 months ago)
• Last Synced: 2024-04-14T13:52:38.294Z (10 months ago)
• Topics: angular, cli, console, generator, info, input, library, nx, oclif, react, readme, schematics, tools, vue
• Language: TypeScript
• Homepage: https://npmjs.org/package/schematics-readme
• Size: 190 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
schematics-readme

===============

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/schematics-readme.svg)](https://npmjs.org/package/schematics-readme)

[![CircleCI](https://circleci.com/gh/EndyKaufman/schematics-readme/tree/master.svg?style=shield)](https://circleci.com/gh/EndyKaufman/schematics-readme/tree/master)

[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/EndyKaufman/schematics-readme?branch=master&svg=true)](https://ci.appveyor.com/project/EndyKaufman/schematics-readme/branch/master)

[![Codecov](https://codecov.io/gh/EndyKaufman/schematics-readme/branch/master/graph/badge.svg)](https://codecov.io/gh/EndyKaufman/schematics-readme)

[![Downloads/week](https://img.shields.io/npm/dw/schematics-readme.svg)](https://npmjs.org/package/schematics-readme)

[![License](https://img.shields.io/npm/l/schematics-readme.svg)](https://github.com/EndyKaufman/schematics-readme/blob/master/package.json)

Generator `README.md` file for [Angular Schematics](https://angular.io/guide/schematics-for-libraries) collection

# Install

```bash

npm i -g schematics-readme

```

## Links

[Fake generators](https://github.com/EndyKaufman/schematics-readme/blob/master/test/fixtures/fake-generators/README.md) - Fake generators for test.

# Usage

Open folder with schematic workspace and run

```bash

npx schematics-readme

```

Run on target folder

```bash

npx schematics-readme ./library

```

# License

MIT