Skip to content

Commit

Permalink
doc: Adding imports documentation for badge (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
croquet-mickael authored and guillaumechervetaxa committed Feb 8, 2019
1 parent 7c2d57c commit 9e32ed5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ experience for everyone, regardless of the experience level, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, age or religion.

Examples of unacceptable behaviour by participants include the use of sexual
Examples of unacceptable behavior by participants include the use of sexual
language or imagery, derogatory comments or personal attacks, trolling, public
or private harassment, insults or other unprofessional conduct.

Expand All @@ -19,7 +19,7 @@ reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct. Project maintainers who do not
follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing or otherwise unacceptable behaviour may be
Instances of abusive, harassing or otherwise unacceptable behavior may be
reported by opening an issue or contacting one or more of the project
maintainers.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- [Getting Started](#getting-started)
- [Packages](#packages)
- [Concept](#concept)
- [How Does It Work](#how-it-works)
- [How Does It Work](#how-does-it-work)
- [Contribute](#contribute)
- [Roadmap](#roadmap)
- [Demo](#demo)
Expand All @@ -17,7 +17,7 @@

A set of independent components. Awesome library based on HTML and CSS using BEM convention with the JavaScript ReactJS implementation. Each components are autonomous and extensible. Pick and use only what you need!

**How can you do CSS isolation?**
**How *React-toolkit* does CSS isolation?**

Only by using [BEM (Block Element Modifier)](http://getbem.com) CSS convention. No need of the intricate technologies, just pragatism.

Expand Down
10 changes: 10 additions & 0 deletions packages/badge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ npm i "@axa-fr/react-toolkit-badge"

For more information about style component, you can see the [Badge Style on Toolkit-core ](http://toolkit-intranet-axa.azurewebsites.net/#/badge)

### Import

```javascript
import Badge from '@axa-fr/react-toolkit-badge';

import '@axa-fr/react-toolkit-badge/dist/badge.scss';
/* or */
import '@axa-fr/react-toolkit-badge/dist/af-badge.css';
```

### Sample

```javascript
Expand Down

0 comments on commit 9e32ed5

Please sign in to comment.