日本語 / English

I read you (ireadu)

Extracting commands from README markdown file.

Supported on Linux, Windows Subsystems for Linux and macOS.

Installation

$ npm install --global i-read-u

Requirements

Node.js v6.0+

Usage

$ ireadu
$ ireadu ./CONTRIBUTING.md

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

Test Commands (Try ireadu command and hit this)

$ ls
$ pwd
> w
>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
$ file=coverage/lcov-report/index.html && if type cmd.exe; then cmd.exe /c start ${file}; else open ${file}; fi

License

Copyright (c) 2018 s2terminal / suzuki.sh (Twitter: suzukiterminal) Licensed under the MIT license.