Readme update

This commit is contained in:
Alexander Bell 2018-06-06 10:34:56 -07:00
parent 47aae95143
commit b4dc4defb6
2 changed files with 4 additions and 51 deletions

View File

@ -5,54 +5,7 @@
React component that mounts three dot button that morphs into a menu by clicking on it.
Never ever worry about a fancy dropdown menu. This component does it for you!
# Installation
# Usage, Example and Tutorial
`npm install --save react-animated-menus`
# Usage
`import Menu from 'react-animated-menus'`
Component usage:
```jsx
const food = {
a: {
value: "Button1",
action: () => {
alert("test1")
}
},
b: {
value: "Button2",
action: () => {
alert("test2")
}
},
c: {
value: "Button3",
action: () => {
alert("test3")
}
}
}
<Menu width={"20px"} color="rgb(123, 192, 222)" food={food} />
//Replace 'width' optionally with 'height' but don't use both at the same time.
//To keep the ratio between height and width one has to be given and the other one is calculated by the component.
//One example with height:
<Menu height={"50px"}" food={food} />
//'color' is optional. The defaul value is 'rgb(255, 255, 255)' if it's not defined.
```
# Contact
**Github:** https://github.com/aleabodo
**Wesite:** https://alexbell.ninja
**Email:** mail@alexbell.de
Visit
https://alexbell.ninja/react-animated-menus

View File

@ -1,6 +1,6 @@
{
"name": "react-animated-menus",
"version": "1.0.5",
"version": "1.0.6",
"description": "React component that mounts three dot button that morphs into a menu by clicking on it.",
"main": "./lib/index.js",
"license": "MIT",