Skip to content

Commit

Permalink
Remove Octicon example from react README.md (#1012)
Browse files Browse the repository at this point in the history
Looks like 697bf97 only deleted the section title, not the actual section in the README
  • Loading branch information
smithamax committed Mar 13, 2024
1 parent 45f4fe9 commit efe0ca3
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions lib/octicons_react/README.md
Expand Up @@ -158,20 +158,6 @@ export default () => (
)
```


```diff
- <Octicon icon={AlertIcon} />
+ <AlertIcon />
```

The `Octicon` component is wrapper that passes props to its icon component. To render a specific icon, you
can pass it either via the `icon` prop, or as the only child:

```jsx
<Octicon icon={Icon} />
<Octicon><Icon x={10}/></Octicon>
```

[octicons]: https://primer.style/octicons/
[primer]: https://github.com/primer/primer
[docs]: http://primercss.io/
Expand Down

0 comments on commit efe0ca3

Please sign in to comment.