https://github.com/ulivz/akai

Salubrious generator
https://github.com/ulivz/akai

Last synced: 7 months ago
JSON representation

Salubrious generator

• Host: GitHub
• URL: https://github.com/ulivz/akai
• Owner: ulivz
• Created: 2017-09-17T12:36:22.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-07-30T16:12:06.000Z (about 6 years ago)
• Last Synced: 2024-09-25T09:14:07.103Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 542 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  





  Salubrious generator






## Badges

[![NPM version](https://img.shields.io/npm/v/akai.svg?style=flat)](https://npmjs.com/package/akai)

[![NPM downloads](https://img.shields.io/npm/dm/akai.svg?style=flat)](https://npmjs.com/package/akai)

[![codecov](https://codecov.io/gh/ulivz/akai/branch/master/graph/badge.svg)](https://codecov.io/gh/ulivz/akai)

[![CircleCI](https://circleci.com/gh/ulivz/akai/tree/master.svg?style=shield)](https://circleci.com/gh/ulivz/akai/tree/master)

[![codecov](https://codecov.io/gh/ulivz/akai/branch/master/graph/badge.svg)](https://codecov.io/gh/ulivz/akai)  

## Install

Install _akai_:

```bash

# Either globally

yarn global add akai

# Or locally (preferred)

yarn add akai --dev

```

or, If you use `npm`:

```bash

npm i akai -g

npm i akai --save-dev

```

## Usage

Runtime:

```js

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](https://github.com/ulivz/akai) - akai itself.

- Feel free to submit yours via pull request :D

## Author



  



**akai** © [ULIVZ](https://github.com/ulivz), Released under the [MIT](./LICENSE) License.


Authored and maintained by ULIVZ with help from contributors ([list](https://github.com/ulivz/akai/contributors)).

> [v2js.com](http://www.v2js.com) · GitHub [@ULIVZ](https://github.com/ulivz)