Skip to content

Commit 091a043

Browse files
committed
docs(readme): update readme and add contributors
1 parent 743c5ee commit 091a043

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

.all-contributorsrc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"projectName": "react-use-presentation",
3+
"projectOwner": "olavoparno",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 70,
10+
"commit": false,
11+
"contributors": [
12+
{
13+
"login": "olavoparno",
14+
"name": "Olavo Parno",
15+
"avatar_url": "https://avatars1.githubusercontent.com/u/7513162?v=4",
16+
"profile": "https://olavoparno.github.io",
17+
"contributions": [
18+
"ideas",
19+
"code",
20+
"test"
21+
]
22+
}
23+
],
24+
"contributorsPerLine": 7,
25+
"skipCi": true
26+
}

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [Install](#install)
1515
- [Usage](#usage)
1616
- [Documentation](#documentation)
17+
- [Contributors](#contributors)
1718
- [License](#license)
1819

1920
---
@@ -25,6 +26,8 @@
2526
| ![Example](./assets/readme.gif) | ![Example](./assets/readme-bg.gif) |
2627
| [Preview!](https://codesandbox.io/s/react-use-presentation-1c2du) | [Preview with BG video!](https://codesandbox.io/s/react-use-presentation-with-bg-d7f7j) |
2728

29+
> You may also find a running [example](./example) in this project which are served at [Github Pages](https://olavoparno.github.io/react-use-presentation).
30+
2831
---
2932

3033
## Install
@@ -193,6 +196,7 @@ import { myFramesArray1 } from './myFramesArray';
193196

194197
export default function App() {
195198
const [startTrigger, setStartTrigger] = React.useState(false);
199+
196200
const [PresentationTriggered] = usePresentation({
197201
framesOptions: myFramesArray1,
198202
startTrigger,
@@ -250,6 +254,50 @@ const [
250254
] = usePresentation();
251255
```
252256

257+
`CSS selectors`:
258+
259+
- Both frames with or without children have its own CSS selectors:
260+
261+
1. Without children: `className="animation-frame"`
262+
2. With children: `className="animation-frame with-children"`
263+
264+
- You can also pass in your own className:
265+
266+
1. With or without children:
267+
268+
```tsx
269+
const [PresentationCustomCss] = usePresentation({
270+
framesOptions: myFramesArray1,
271+
startTrigger: true,
272+
});
273+
274+
return <PresentationCustomCss className="my-custom-class" />;
275+
```
276+
277+
- **The default behaviour is to automatically merge classNames.**
278+
279+
---
280+
281+
## Contributors
282+
283+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
284+
285+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
286+
<!-- prettier-ignore-start -->
287+
<!-- markdownlint-disable -->
288+
<table>
289+
<tr>
290+
<td align="center"><a href="https://olavoparno.github.io"><img src="https://avatars1.githubusercontent.com/u/7513162?v=4?s=70" width="70px;" alt=""/><br /><sub><b>Olavo Parno</b></sub></a><br /><a href="#ideas-olavoparno" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/olavoparno/react-use-presentation/commits?author=olavoparno" title="Code">💻</a> <a href="https://github.com/olavoparno/react-use-presentation/commits?author=olavoparno" title="Tests">⚠️</a></td>
291+
</tr>
292+
</table>
293+
294+
<!-- markdownlint-restore -->
295+
<!-- prettier-ignore-end -->
296+
297+
<!-- ALL-CONTRIBUTORS-LIST:END -->
298+
299+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
300+
253301
---
254302

255303
## License

0 commit comments

Comments
 (0)