-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ricardo Snoek
committed
Sep 12, 2019
1 parent
b57f907
commit 7b441e2
Showing
2 changed files
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git] | ||
|
||
# pubplish | ||
$ npm publish | ||
``` | ||
|
||
## License | ||
[MIT](https://opensource.org/licenses/MIT) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters