@pshaw/writeme
Version:
A readme generator
25 lines (18 loc) • 422 B
Markdown
# Writeme
A readme generator
## Installation
```bash
npm install --save-dev @pshaw/writeme
```
or
```bash
yarn add --dev @pshaw/writeme
```
## Examples
```javascript
import writeme from '@pshaw/writeme';
// Point to where the directory where the package.json and writeme.config.js files are
writeme(__dirname);
```
---
This documentation was generated using [writeme](https://www.npmjs.com/package/@pshaw/writeme)