Giter VIP home page Giter VIP logo

akai's Introduction

logo.svg

Salubrious generator


Badges

NPM version NPM downloads codecov CircleCI codecov

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

logo.svg

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

v2js.com · GitHub @ULIVZ

akai's People

Contributors

ulivz avatar

Stargazers

avatar

Watchers

avatar avatar

akai's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.