About The Project

There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a README from scratch
• You should implement DRY principles to the rest of your life :smile:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

Use the BLANK_README.md to get started.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 
• 
• 
• 
• Storybook
• Husky

Installation

How to run a project, please follow the instructions below.

npm install --save posy-fnb-core

or if you are using yarn :

yarn add posy-fnb-core

Usage

How to add a packages into your project, please follow the instructions below.

1. import component

import { Button } from 'posy-fnb-core'

function App() {
  return <Button variant="primary">Hello World</Button>;
}

2. import styles

import 'posy-fnb-core/dist/index.css'

3. import preset (optional)

const preset = require('posy-fnb-core/dist/preset.cjs') // add this line

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    './index.html',
    './src/**/*.{js,ts,jsx,tsx}',
  ],
  presets: [ preset ],
  theme: {
    extend: {},
  },
  plugins: [],
}

Roadmap

• [x] Slicing components
• [x] Add documentation using storybook
• [x] Automate deploy using vercel
• [ ] add unit testing components
• [ ] Automate deploy storybook using vercel

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

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Muammar Zaidan - @zaidanammar - [email protected]

Project Link: posy-fnb-core

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Img Shields
• React Icons