mirror of
https://github.com/Mastermindzh/react-cookie-consent.git
synced 2025-01-20 18:41:44 +01:00
updated contributor info, added a TOC and installed lint-staged
This commit is contained in:
parent
75ff4a09e6
commit
9169c132fe
30
README.md
30
README.md
@ -12,6 +12,28 @@ Example branch: https://github.com/Mastermindzh/react-cookie-consent/tree/exampl
|
||||
|
||||
![default look](https://raw.githubusercontent.com/Mastermindzh/react-cookie-consent/master/images/default.png)
|
||||
|
||||
## Table of contents
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Using it](#using-it)
|
||||
- [Props](#props)
|
||||
- [Debugging it](#debugging-it)
|
||||
- [Styling it](#styling-it)
|
||||
- [Examples](#examples)
|
||||
- [changing the bar background to red](#changing-the-bar-background-to-red)
|
||||
- [changing the button font-weight to bold](#changing-the-button-font-weight-to-bold)
|
||||
- [Using predefined CSS classes](#using-predefined-css-classes)
|
||||
- [Accept on scroll](#accept-on-scroll)
|
||||
- [Flipping the buttons](#flipping-the-buttons)
|
||||
- [Extra cookie options](#extra-cookie-options)
|
||||
- [rainbows!](#rainbows)
|
||||
- [contributor information](#contributor-information)
|
||||
- [Projects using react-cookie-consent](#projects-using-react-cookie-consent)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
@ -253,6 +275,14 @@ If you're crazy enough you can even make a rainbow colored bar:
|
||||
[declinebuttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L41-L51
|
||||
[contentstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L52-L55
|
||||
|
||||
## contributor information
|
||||
|
||||
When making a PR please think about the following things:
|
||||
|
||||
- Update the ChangeLog (or include what you did in the PR and I'll add it, up to you)
|
||||
- No need to build or update the package.json. I will do both on release.
|
||||
- Please don't change code convention / style
|
||||
|
||||
## Projects using react-cookie-consent
|
||||
|
||||
The list below features the projects which use react-cookie-consent (that I know off):
|
||||
|
@ -67,8 +67,7 @@
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{js*,ts*,htm*,md,scss}": [
|
||||
"prettier --write",
|
||||
"git add"
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user