nonagon v1.2.0

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• NodeJS
• React

Getting Started

You only need one step to get started:

1. Install nonagon

   $ npm -i nonagon

   or

   $ yarn add nonagon

Prerequisites

The application requires the following to be installed on your system in order to run:

• NodeJS v14.15.0
• npm 6.14.8

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

NB: if you intend to add a feature or make changes that will go into the final product, you must create an issue on the project board, and comply to the contributing guidelines, if you are just messing around, or would like to build your own project on top of Nonagon, feel free to do as you please, as long as you're not violating the license agreement.

1. Fork the Project
2. Create your Branch

   $ git checkout -b branchName

3. Make your changes
4. Commit your Changes

   $ git commit -m "Add some amazing feature or changes"

5. Push to the Branch

   $ git push origin branchName

6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

George Munyoro - @george_munyoro Project Link: https://github.com/georgemunyoro/nonagon