Skip to content

Commit

Permalink
Minor cleanup of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kristofer Selbekk committed Sep 15, 2016
1 parent 3340ad0 commit d544b08
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ffe-checkbox-react
# ffe-checkbox-react

React implementation of the checkbox found in FFE

Expand All @@ -8,8 +8,9 @@ React implementation of the checkbox found in FFE
$ npm install --save ffe-checkbox-react
```

`ffe-checkbox-react` depends on `ffe-core` being present and imported in your project.
More specifically, the CSS classes related to checkboxes in ffe-core should be in your CSS Object Model when using this component.
`ffe-checkbox-react` depends on `ffe-core` being present and imported in your
project. More specifically, the CSS classes related to checkboxes in ffe-core
should be in your CSS Object Model when using this component.

## Usage

Expand All @@ -21,7 +22,7 @@ import Checkbox from 'ffe-checkbox-react';
checked={ boolean }
name={ string }
label={ string }
noMargins={ boolean} // disables top- and bottom margins, useful for use in tables etc
noMargins={ boolean } // disables top- and bottom margins, useful for use in tables etc
/>
```

Expand All @@ -33,4 +34,4 @@ If you need a more complex description, use `children`:
Some text
<AnotherIcon />
</Checkbox>
```
```

0 comments on commit d544b08

Please sign in to comment.