Skip to content

Commit

Permalink
[DOCS]: link docs entries in README (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
Joaquín R. Montes authored Jun 8, 2023
1 parent 5bdd995 commit 7570743
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ BSMNT Scrollytelling is a library for creating Scrollytelling animations. It's p

![Frame 7](https://user-images.githubusercontent.com/40034115/233121992-12eb2448-4f62-4cba-b9a3-c0d3e9233aa7.jpg)

---
### 👇 New documentation here! 👇

- 💡 [Core Concepts](/docs/core-concepts.md)
- 📕 [API Reference](/docs/api.md)

---

## Installation

To get started, we'll need the `@bsmnt/scrollytelling` package, as well as the required peer dependency: [GSAP](https://greensock.com/docs/).
Expand Down
6 changes: 6 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,9 @@ export const HomePage = () => (
#### Example

https://stackblitz.com/edit/react-ts-kittrj

---

## Next Steps

💡 [Core concepts](/docs/core-concepts.md)
7 changes: 6 additions & 1 deletion docs/core-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,9 @@ From [gsap docs](https://greensock.com/docs/v3/GSAP/Tween):
In this library we took this tween definition and use it with a few tweaks[^1] for our `Animation` component and its variants (`Pin`, `Parallax`, etc.)

[^1]: For example we remove the duration and use `start` and `end` props based on the scrolling progress inside the `<Pin />` component to set the correct duration for each animation (_tween_).
[^1]: For example we remove the duration and use `start` and `end` props based on the scrolling progress inside the `<Pin />` component to set the correct duration for each animation (_tween_).

---
## Next Steps

📕 [API Reference](/docs/api.md)

1 comment on commit 7570743

@vercel
Copy link

@vercel vercel bot commented on 7570743 Jun 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.