diff --git a/README.md b/README.md new file mode 100644 index 0000000..06ff4b7 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# React Drawable + +Simple package that provide React components to draw lines using mouse or touch events. + +## Prerequisites + +- React >= 16.8 + +## Install + +`npm install react-drawable --save` + +## Usage + +Keep in mind this component **has no styles**, so you should set at least its size to be able to use it. **You should handle this by providing a className and setting styles to it**. Same if you want to be able to draw over some other element or something special. **Be creative!** 😉 + +### Simple: +```javascript +import * as React from 'react' +import { DrawProvider } from 'react-drawable' + +export const Sample = () => +``` + +### With options: +```javascript +import * as React from 'react' +import { DrawProvider } from 'react-drawable' + +export const Sample = () => { + const [paused, setPaused] = React.useState(false) + const [hidden, setHidden] = React.useState(false) + + return ( + <> +