Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 Update doc to use npx #55

Merged
merged 2 commits into from
Jun 17, 2019
Merged

📝 Update doc to use npx #55

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4747ad5
Update docs to use npx
samit4me Jun 17, 2019
a855ba8
Update README.md
samit4me Jun 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 6 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,33 +56,22 @@ Example of `package.json` with good meta data:
}
```

## 📦 Install
## 🚀 Usage

With npm:
Make sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since npm `5.2.0`)

```sh
npm i -g readme-md-generator
```

With yarn:
Just run the following command at the root of your project and answer questions:
samit4me marked this conversation as resolved.
Show resolved Hide resolved

```sh
yarn global add readme-md-generator
npx readme-md-generator
```

## 🚀 Usage

Just run the following command at the root of your project and answer questions:
OR use default values for all questions (`-y, --yes`):

```sh
readme
npx readme-md-generator -y
```

### Available options

- `--version` Display `readme-md-generator` version number
- `-y, --yes` Use default values for all questions

## 🤝 Contributing

Contributions, issues and feature requests are welcome.<br />
Expand Down