A Yeoman generator to create Flynt Components & Features
Switch branches/tags
Clone or download
Latest commit 39869e2 May 17, 2018

README.md

Flynt Yeoman Generator (generator-flynt)

standard-readme compliant

A Yeoman generator for Flynt

Table of Contents

Install

The node version used should be ^6. If you use a node version manager (e.g. nave), use npm to install globally:

$ npm i -g @flyntwp/generator-flynt

Otherwise you can use yarn as well:

$ yarn global add @flyntwp/generator-flynt

Usage

Run yo @flyntwp/flynt to start the generator. You can select between Components and Features.

Maintainers

This project is maintained by bleech.

The main people in charge of the repo are:

Contribute

To contribute, please use GitHub issues. Please also take a moment to read the Contributing Guidelines and Code of Conduct.

If you are a developer and would like to submit a pull request, do the following:

  1. Fork the project and clone it.
  2. Run npm install inside the cloned folder.
  3. Run npm link to link the local installation for development purposes. (Run npm unlink to undo this step.)
  4. In any folder run yo @flyntwp/flynt to run your local development version and test your changes.
  5. Send a pull request from your fork to the main repo's master branch.

If editing the README, please conform to the standard-readme specification.

License

MIT © bleech