From eff54ff042df3634cf2a982191124184e7896f5b Mon Sep 17 00:00:00 2001 From: Elyse Holladay Date: Thu, 23 May 2019 12:05:24 -0500 Subject: [PATCH] add readme-toc script, update readme with npx instructions --- README.md | 31 +++++-------------------------- TODO.md | 9 ++++++++- package.json | 3 ++- 3 files changed, 15 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index b879278..4fb43e5 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,9 @@ > A generator that creates standard templates for common repository documentation. -To make it easy for engineers on your team to do the right thing and write great documentation, this package generates standard documentation templates. Using a Yeoman generator CLI, you can answer questions to get a pre-filled README and other documentation. +To make it easy for engineers on your team to do the right thing and write great documentation, this package generates standard documentation templates. Using a Yeoman generator CLI, you can answer questions to get a pre-filled README. * **README** — As the entry point to the tool, a good README should explain what the tool is, how to use and install it, and how to get in touch with maintainers. A standard README template makes it easy for consumers to find the information they need. -* **CONTRIBUTING** — Contributing information helps turn consumers into collaborators, by describing how to install, contribute, code review, and participate in the tool's development. -* **CHANGELOG** — A changelog, both automatically generated and human-augmented, helps consumers understand the changes between versions. A changelog is a crucial part of understanding how to upgrade. -* **CODE_OF_CONDUCT** — Based on the [Contributor Covenant](https://www.contributor-covenant.org/), a code of conduct governs how we interact with contributors to our projects. -* **LICENSE** — Optional, but useful if you want your project to be shared and used. A license is required for many organizations to use OS projects. ## Table of Contents @@ -19,29 +15,15 @@ To make it easy for engineers on your team to do the right thing and write great * [Contributing](#contributing) * [License](#license) -## Install -First install [Yeoman](https://yeoman.io), and this package, with npm: - -```bash -npm install -g yo -npm install -g generator-standard-docs-templates -``` +## Usage +This currently only works locally, as this package is not published to npm. In this project, run `npm link .` -Then to run the generator: +Then, in the project where you want to generate a README, run the generator with npx: ```bash -yo standard-docs-templates +npx yo generator-standard-docs-templates ``` -### Prerequisites -Requires [Node](https://nodejs.org), [npm](https://www.npmjs.com), and [Yeoman](https://yeoman.io). - -## Usage -_TBD_ - -### CLI -_TBD_ - ## Releases This project follows [Semantic Versioning](https://semver.org/). Release versions can be found on the [Releases page](https://github.com/elyseholladay/generator-standard-docs-templates/releases). @@ -55,8 +37,5 @@ Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to con `this-project` is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). -### Local Development -_TBD_ - ## License `this-project` is licensed under the [MIT License](LICENSE). diff --git a/TODO.md b/TODO.md index 854a8a0..7d96a6a 100644 --- a/TODO.md +++ b/TODO.md @@ -2,4 +2,11 @@ * add list of files the generator creates * update with instructions for `npx`. -* can we check to see if the tool name matches the repo name, and fail if it doesn't? Do we _want_ to do that? \ No newline at end of file +* can we check to see if the tool name matches the repo name, and fail if it doesn't? Do we _want_ to do that? + +## Coming Soon + +* **CONTRIBUTING** — Contributing information helps turn consumers into collaborators, by describing how to install, contribute, code review, and participate in the tool's development. +* **CHANGELOG** — A changelog, both automatically generated and human-augmented, helps consumers understand the changes between versions. A changelog is a crucial part of understanding how to upgrade. +* **CODE_OF_CONDUCT** — Based on the [Contributor Covenant](https://www.contributor-covenant.org/), a code of conduct governs how we interact with contributors to our projects. +* **LICENSE** — Optional, but useful if you want your project to be shared and used. A license is required for many organizations to use OS projects. \ No newline at end of file diff --git a/package.json b/package.json index f5c6780..29f0bcc 100644 --- a/package.json +++ b/package.json @@ -72,7 +72,8 @@ }, "scripts": { "pretest": "eslint .", - "test": "jest" + "test": "jest", + "update-readme-toc": "npx markdown-toc README.md --maxdepth=2 -i --bullets '* '" }, "repository": "elyseholladay/generator-standard-docs-templates", "license": "MIT"