react-bnb-gallery/README.md

Simple photo gallery based on React and Airbnb image gallery

<p>
  <img alt="react-bnb-gallery" width="250" src="https://raw.githubusercontent.com/peterpalau/react-bnb-gallery/master/rbg-logo.png" /><br />
  Friendly, customizable and accessible-ready simple photo gallery based on React.
</p>

<p>
  <a href="https://www.npmjs.com/package/react-bnb-gallery" target="_blank"><img src="https://img.shields.io/npm/v/react-bnb-gallery.svg" alt="NPM"></a>
  <a href="http://www.npmjs.com/package/react-bnb-gallery" target="_blank"><img src="http://img.shields.io/npm/dm/react-bnb-gallery.svg?style=flat" alt="Download Count" /></a>
  <a href="https://travis-ci.org/peterpalau/react-bnb-gallery" target="_blank"><img src="https://travis-ci.org/peterpalau/react-bnb-gallery.svg?branch=master" alt="Build Status" /></a>
  <a href="https://david-dm.org/peterpalau/react-bnb-gallery" target="_blank"><img src="https://david-dm.org/peterpalau/react-bnb-gallery.svg" alt="Dependencies" /></a>
  <a href="https://david-dm.org/peterpalau/react-bnb-gallery?type=dev" taret="_blank"><img src="https://david-dm.org/peterpalau/react-bnb-gallery/dev-status.svg" alt="Dev Dependencie" /></a>
</p>

------

## Install

You can install [react-bnb-gallery](https://www.npmjs.com/package/react-bnb-gallery) from [npm](https://www.npmjs.com/).

```bash
# If you are using npm
npm install --save react-bnb-gallery

# If you prefer yarn
yarn add react-bnb-gallery
```

## Live Demo

[https://peterpalau.github.io/react-bnb-gallery/](https://peterpalau.github.io/react-bnb-gallery/)

![Demo](https://raw.githubusercontent.com/peterpalau/react-bnb-gallery/master/react-bnb-demo.png)

## Documentation

For full documentation, visit the [demo website](https://peterpalau.github.io/react-bnb-gallery).

## License

This package have been released under the [MIT Licence](https://raw.githubusercontent.com/peterpalau/react-bnb-gallery/master/LICENSE).

## Updates

If you are interested in view the main updates visit our [CHANGELOG.md](https://github.com/peterpalau/react-bnb-gallery/blob/master/CHANGELOG.md).

## Contributing

If you're interested in contributing please read the [contributing docs](https://github.com/peterpalau/react-bnb-gallery/blob/master/CONTRIBUTING.md) **before submitting a pull request**.