mbeauv/flash-message-react

# flash-message-react

[![Maintainability](https://api.codeclimate.com/v1/badges/30b532acb3f84c2708b5/maintainability)](https://codeclimate.com/github/mbeauv/flash-message-react/maintainability)

Companion library to flash-message-redux.  While flash-message-redux is all about putting transient messages in your redux store,
flash-message-react is about displaying it on the screen. This is akin to a toast message or a flash message in the Rails world.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. 

### Installing

flash-message-react is an npm module and can be downloaded from the npm registry.

Using npm:

```
npm i --save flash-message-react
```

Using yarn:

```
yarn add flash-message-react
```
### Using it

Using the flash-message-react library is fairly easy.  You first need to install flash-message-redux as per the instructions and
then simply use the FlashMessageComponent in your code.

### And coding style tests

If submitting code, please ensure that your code follows the eslint rules we use. Thanks.

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/mbeauv/214b791a2512201886e4833a3c64241f) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Martin Beauvais** - *Initial work* - [mbeauv](https://github.com/mbeauv)

See also the list of [contributors](https://github.com/mbeauv/flash-message-react/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details