Table of contents
Installation
Clone repo:
git clone https://github.com/estidlore/bonbon.git
Install with npm:
npm i @estidlore/bonbon
Install with yarn:
yarn add @estidlore/bonbon
Import
In your main file (i.e. src/index.js) write:
import "@estidlore/bonbon/dist/css/index.css";
import "@estidlore/bonbon/dist/css/animations.css";
or if you want to import the scss:
import "@estidlore/bonbon/scss/index.scss";
import "@estidlore/bonbon/scss/animations.scss";
Documentation
You can read the Bonbon's documentation at estidlore-bonbon.web.app/docs powered by React, Sass and, of course, Bonbon ;-)
IMPORTANT: Please, remember that Bonbon is still a "baby" project. New features, fixes and documentation are constantly being added, be patient.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Code and documentation copyright 2022 the Bonbon authors. Code released under the MIT License.
Contact
Estid Felipe Lozano Reyes
- GitHub: https://github.com/estidlore
- LinkedIn: https://www.linkedin.com/in/estidlore