Skip to content

Commit

Permalink
πŸ“ Update doc to use npx (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
samit4me authored and kefranabg committed Jun 17, 2019
1 parent e87ed1a commit 77d6fdc
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions README.md
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:

```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

0 comments on commit 77d6fdc

Please sign in to comment.