Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rofrischmann committed Sep 5, 2018
1 parent 1bcf3a5 commit d57374a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 18 deletions.
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Don't worry - we got you covered. Check [this guide](https://github.com/rofrisch
## Usage

```javascript
import prefix from 'inline-style-prefixer'
import { prefix } from 'inline-style-prefixer'

const style = {
transition: '200ms all linear',
Expand All @@ -62,20 +62,10 @@ output === {
You can use TypeScript definition from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inline-style-prefixer) using [@types/inline-style-prefixer](https://www.npmjs.com/package/@types/inline-style-prefixer)

```sh
npm install --save @types/inline-style-prefixer
```

Then import in your code
yarn add @types/inline-style-prefixer

```typescript
import prefix = require('inline-style-prefixer');

const prefixedStyle = prefix({
transition: '200ms all linear',
boxSizing: 'border-box',
display: 'flex',
color: 'blue'
});
# alternatively use npm
npm i --save @types/inline-style-prefixer
```

## Documentation
Expand All @@ -84,7 +74,6 @@ If you got any issue using this prefixer, please first check the FAQ's. Most cas
* [Usage Guides](https://inline-style-prefixer.js.org/docs/UsageGuides.html)
* [Data Reference](https://inline-style-prefixer.js.org/docs/DataReference.html)
* [API Reference](https://inline-style-prefixer.js.org/docs/API.html)
* [FAQ](https://inline-style-prefixer.js.org/docs/FAQ.html)

## Community
Here are some popular users of this library:
Expand Down
5 changes: 2 additions & 3 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,5 @@
* [3. API Reference](docs/API.md)
* [3.1. prefix](docs/api/prefix.md)
* [3.2. createPrefixer](docs/api/createPrefixer.md)
* 3.3. generator
* [3.3.1. generateData](docs/api/generator/generateData.md)
* [5. CHANGELOG](CHANGELOG.md)
* [3.3. generateData](docs/api/generator/generateData.md)
* [4. Changelog](CHANGELOG.md)

0 comments on commit d57374a

Please sign in to comment.