Skip to content

Commit

Permalink
Added readme and renamed package
Browse files Browse the repository at this point in the history
  • Loading branch information
Ricardo Snoek committed Sep 12, 2019
1 parent b57f907 commit 7b441e2
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
33 changes: 33 additions & 0 deletions README.md
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)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": [
Expand Down

0 comments on commit 7b441e2

Please sign in to comment.