Commit b0d156d3 authored by Brady Paterson's avatar Brady Paterson Committed by GitHub

Added More Info to README

- added an `import` call to include this package

- changed the example use to match the name of the component called from the package
parent a5e92306
......@@ -23,6 +23,11 @@ npm start
React Hamburger Button has only two required props: `open` and `onClick`.
#### include
import { HamburgerButton } from 'react-hamburger-button/dist/index';
#### onClick
Note: This prop is passed a `function`. This function will be invoked when the component is `clicked`. The function should responsible for updating the state that is passed to `open`. The function passed to `onClick` could look something like the following:
......@@ -38,7 +43,7 @@ handleClick() {
An example use of React Hamburger Menu looks like:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment