diff --git a/.gitignore b/.gitignore index 25c8fdb..d5f19d8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ node_modules -package-lock.json \ No newline at end of file +package-lock.json diff --git a/README.md b/README.md index 49e0b1d..7d315a6 100644 --- a/README.md +++ b/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 + + + +- [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) + + + ## 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): diff --git a/package.json b/package.json index 8cae71e..80a5f48 100644 --- a/package.json +++ b/package.json @@ -67,8 +67,7 @@ }, "lint-staged": { "*.{js*,ts*,htm*,md,scss}": [ - "prettier --write", - "git add" + "prettier --write" ] } }