Skip to content

Commit

Permalink
Add Contributing and License
Browse files Browse the repository at this point in the history
  • Loading branch information
evandromacedo committed Oct 22, 2019
1 parent 7b32651 commit 2b19bde
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,14 @@ useSnackbar(options)
withSnackbar(Component, options)
```

## Contributing

See [CONTRIBUTING.md](https://github.com/evandromacedo/react-simple-snackbar/blob/master/CONTRIBUTING.md) for more information on how to get started.

## License

React Simple Snackbar is open source software [licensed as MIT](https://github.com/evandromacedo/react-simple-snackbar/blob/master/LICENSE.md).

<!-- _Add size, gzipped size, and npm version afterwards. Use [these](https://github.com/ngryman/badge-size) for size._
It's meant to be a REALLY simple Snackbar. -->
2 changes: 1 addition & 1 deletion site/src/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ export default withSnackbar(Example)

## Options

You can pass an options object to customize your Snackbar. This object can be passed either in `useSnackbar([options])` or as second argument of `withSnackbar(Component [,options])`. It accepts three options:
You can pass an options object to customize your Snackbar. This object can be passed either in `useSnackbar([options])` or as second argument of `withSnackbar(Component [, options])`. It accepts three options:

- **`position`**: a custom position for your Snackbar. The default value is `bottom-center`, and the possible values are `top-left`, `top-center`, `top-right`, `bottom-left`, `bottom-center` and `bottom-right`.

Expand Down

0 comments on commit 2b19bde

Please sign in to comment.