README
๐ฆ @inspire11/storybook-theme
This package is a standardized branding-compliant theme for Inspire11 Storybook projects.
- ๐ผ Getting Started 1.1 ๐ Prerequisites 1.2 ๐ฒ Installing
- ๐ Testing 2.1 ๐ E2E 2.2 ๐ Static Analysis
- ๐ฅ Deployment
- ๐งพ Important Dependencies
- ๐๐ผ Contributing
- ๐ท Versioning
- ๐ Authors
- ๐ License
- ๐ฏ Acknowledgments
๐ผ Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
๐ Prerequisites
What things you need to install the software and how to install them
Give examples
๐ฒ Installing
To install the package, clone and build the repo, then use npm
to install dependencies.
git clone git@bitbucket.org:inspire11/banners.git
cd banners
npm i
๐ฅ Deployment
To push changes to the theme, update the package version and publish to NPM:
git version patch
npm publish --access=public
๐๐ผ Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
๐ท Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
๐ Authors
- Robert Hameetman - robert.hameetman@inspire11.com
See also the list of contributors who participated in this project.
๐ License
This project is licensed under the MIT License - see the LICENSE.md file for details.