akai

Salubrious generator

Badges

Install

Install akai:

# Either globally 
yarn global add akai
# Or locally (preferred) 
yarn add akai --dev

or, If you use npm:

npm i akai -g
npm i akai --save-dev

Usage

Runtime:

const akai = require('akai').runtime
 
const myReadme = new akai.README({
  username: 'egoist',
  name: 'cac'
})
 
myReadme.text // => Your README

FAQ

How does it works ?

It combines git global configuration, package.json and akai configuration to dynamically generate README

Who is using akai?

• akai - akai itself.
• Feel free to submit yours via pull request :D

Author

akai © ULIVZ, Released under the MIT License.
Authored and maintained by ULIVZ with help from contributors (list).

v2js.com · GitHub @ULIVZ