outline.js/README.md
Lindsay Evans d134ef09ba Initial NPM release:
* Renaming from outline.js to remove-focus-outline
* Updating package.json to include everything NPM requires
* Adding installation & usage instructions to README
* Adding note about v2 to README
2018-09-28 09:44:39 +10:00

39 lines
856 B
Markdown

# remove-focus-outline
> Formerly outline.js
Removes CSS outlines in an accessible manner
Based on http://www.paciellogroup.com/blog/2012/04/how-to-remove-css-outlines-in-an-accessible-manner/
> :new: I'm working busily on version 2 of remove-focus-outline - pop on over to the [project page](https://github.com/lindsayevans/outline.js/projects/1) to see what's happening, or take a look at the [`develop` branch](https://github.com/lindsayevans/outline.js/tree/develop).
## Installation
```sh
npm install remove-focus-outline
```
Or if Yarn is your thing:
```sh
yarn add remove-focus-outline
```
## Usage
ES6 - TypeScript, Babel, etc.
```js
import 'remove-focus-outline';
```
CommonJS - RequireJS etc.
```js
require('remove-focus-outline');
```
HTML `<script>`:
```html
<script src="node_modules/remove-focus-outline/outline.js"></script>
```