diff --git a/README.md b/README.md new file mode 100644 index 0000000..1bfa00d --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# floating-focus-a11y +A clear, beautiful and easy to implement focus-state solution. + +## Installation +With [npm](https://www.npmjs.com/) installed, run +```bash +$ npm install @q42/floating-focus-a11y --save +``` + +## Usage +```javascript +import { FloatingFocus } from '@q42/floating-focus-a11y'; +new FloatingFocus(); +``` + +## Develop +```bash +$ npm run build +$ npm run watch +$ npm run test +``` + +## Deploy +```bash +# bump version +$ npm version [ | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git] + +# pubplish +$ npm publish +``` + +## License +[MIT](https://opensource.org/licenses/MIT) diff --git a/package.json b/package.json index b18dbb9..7cee3cb 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "q42-floating-focus", + "name": "@q42/floating-focus-a11y", "version": "1.0.0", "description": "An a11y focus solution that is clear, beautiful and easy to implement.", "keywords": [