日本語 / English

npm version CircleCI

I read you (ireadu)

Extracting commands from README markdown file.

I read you (ireadu) demo movie

Supported on Linux, Windows Subsystems for Linux and macOS.

Installation

$ npm install --global i-read-u

Requirements

Node.js v6.0+

Usage

$ ireadu
$ ireadu --file ./CONTRIBUTING.md

More usage information can be obtained from $ ireadu --help.

Test Commands (Try ireadu command and hit this)

$ ls
>w

…and ` # pwd, id`.

Developing

git clone and run this.

$ npm install --save-dev
$ npm run webpack-watch
$ bin/ireadu.js

Linting

$ npm run lint
$ npm run lint:fix

Testing

$ npm test
$ explorer.exe `wslpath -w coverage/lcov-report/index.html`

License

MIT.