From a8435ed88fe809581992e47f9ad85e4de3d43d4a Mon Sep 17 00:00:00 2001 From: mostafa rostami <62288229+MostafaRostami72@users.noreply.github.com> Date: Mon, 26 Apr 2021 21:57:20 +0430 Subject: [PATCH] Create README.md --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fb3b0e1 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# reactjs-accordions + +> A useful and simple package to create an react accordion. + +[![NPM](https://img.shields.io/npm/v/reactjs-accordions.svg)](https://www.npmjs.com/package/reactjs-accordions) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) + +## Full Document +- [Document](https://mostafarostami72.github.io/reactjs-accordions/) +## Demo +- [Demo](https://mostafarostami72.github.io/reactjs-accordions/) + + +## Install + +```bash +npm install --save reactjs-accordions +``` + +## Usage + +```jsx +import React from 'react' + +import Accordions from 'reactjs-accordions'; +import 'reactjs-accordions/dist/index.css'; + +const Example = () => { + + const items = [ + {title: 'Accordion title 1', caption: 'Accordion content 1'}, + {title: 'Accordion title 2', caption: 'Accordion content 2'}, + {title: 'Accordion title 3', caption: 'Accordion content 3'}, + {title: 'Accordion title 4', caption: 'Accordion content 4'}, + ]; + + return ( +
+ +
+ ); +}; + +export default Example; +``` + + +## Support +We are glad you choose this package. If this package is useful for you, please give us a star. + +## License + +MIT © [MostafaRostami72](https://github.com/MostafaRostami72)