Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
add all additional props for featured badge
  • Loading branch information
ryansrofe committed Jun 23, 2022
1 parent 003d903 commit a74eb07
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ See [featuredLogos](https://github.com/FormidableLabs/formidable-oss-badges/tree
- `urql`
- `victory`
- `nuka`
- `owl`

### Additional props

| Prop | Type | Description | Default |
| ----------- | ------- | ------------------------ | ------- |
| className | String | Additional class names | `''` |
| isHoverable | Boolean | Add hover style effects | `false` |
| small | Boolean | Small badge w/ icon only | `false` |

## IconBadge

Expand Down Expand Up @@ -126,7 +135,6 @@ ProjectBadge with svg child:

### IconBadge Usage


**Example 4**:

```jsx
Expand Down Expand Up @@ -173,7 +181,6 @@ You can then edit `examples/src/App.js`, either by returning the components dire

Note that this array is currently just used for passing _props_ into `<ProjectBadge />` and not for passing children or for rendering `<IconBadge />`.


## Maintenance Status

**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
Expand Down

0 comments on commit a74eb07

Please sign in to comment.