Skip to content

Commit 7a1a466

Browse files
authored
refactor: monorepo README (#8896)
## Summary Sometimes people get confused when Worklets link them to the repository for the source code, since there's no mention of Worklets in the README. This PR changes that. ## Test plan 🚀
1 parent b484a80 commit 7a1a466

File tree

4 files changed

+78
-13
lines changed

4 files changed

+78
-13
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
<img src="https://user-images.githubusercontent.com/16062886/117443145-ff868480-af37-11eb-8680-648bccf0d0ce.png" alt="React Native Reanimated by Software Mansion" width="100%">
1+
<img src="https://github.com/user-attachments/assets/a516a6ef-fc1e-4d38-a4d8-6d53d6e51a21" alt="React Native Reanimated and React Native Worklets by Software Mansion" width="100%">
2+
3+
# Reanimated & Worklets
4+
5+
This repository contains two main packages:
6+
7+
- [React Native Reanimated](/packages/react-native-reanimated) — a library for creating smooth animations and interactions in React Native,
8+
- [React Native Worklets](/packages/react-native-worklets) — a library that enables multi-threaded JavaScript execution in React Native applications.
29

310
### Create smooth animations with an excellent developer experience.
411

512
> Reanimated 4 is here! Check out our [documentation page](https://docs.swmansion.com/react-native-reanimated/) for more information
613
7-
### Nightly CI state
14+
## Nightly CI state
815

916
[![NPM Reanimated publish nightly](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-reanimated-publish-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-reanimated-publish-nightly.yml)
1017
[![NPM Worklets publish [Nightly]](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-worklets-publish-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-worklets-publish-nightly.yml)
@@ -20,17 +27,20 @@
2027

2128
## Installation
2229

23-
Check out the [installation](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/#installation) section of our docs for the detailed installation instructions.
30+
Check out the detailed installation [instructions for Reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/#installation) and [instructions for Worklets](https://docs.swmansion.com/react-native-worklets/docs/getting-started/#installation) their dedicated documentation pages.
2431

2532
## Compatibility
2633

27-
React Native Reanimated 4.x supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page) and three latest React Native versions.
34+
Reanimated 4.x and Worklets support only the [New React Native architecture](https://reactnative.dev/architecture/landing-page) and three latest React Native versions.
2835

2936
If your app still runs on the old architecture, please consider adopting the New Architecture or stay with latest 3.x release.
3037

3138
## Documentation
3239

33-
Check out our dedicated documentation page for info about this library, API reference and more: [https://docs.swmansion.com/react-native-reanimated/](https://docs.swmansion.com/react-native-reanimated/)
40+
You can find more information about Reanimated and Worklets, their API references and more in their dedicated documentation pages:
41+
42+
- Reanimated — [https://docs.swmansion.com/react-native-reanimated/](https://docs.swmansion.com/react-native-reanimated/)
43+
- Worklets — [https://docs.swmansion.com/react-native-worklets/](https://docs.swmansion.com/react-native-worklets/)
3444

3545
## Examples
3646

@@ -39,7 +49,7 @@ If you want to play with the API but don't feel like trying it on a real app, yo
3949

4050
## License
4151

42-
Reanimated library is licensed under [The MIT License](LICENSE).
52+
Reanimated and Worklets libraries are licensed under [The MIT License](LICENSE).
4353

4454
## Credits
4555

@@ -51,8 +61,8 @@ This project has been built and is maintained thanks to the support from [Shopif
5161

5262
## Community Discord
5363

54-
[Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about Reanimated or other Software Mansion libraries.
64+
[Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about Reanimated, Worklets or other Software Mansion libraries.
5565

56-
## Reanimated is created by Software Mansion
66+
## Reanimated and Worklets are created by Software Mansion
5767

5868
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=reanimated&utm_medium=readme).
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<img src="https://user-images.githubusercontent.com/16062886/117443145-ff868480-af37-11eb-8680-648bccf0d0ce.png" alt="React Native Reanimated by Software Mansion" width="100%">
2+
3+
### Create smooth animations with an excellent developer experience.
4+
5+
> Reanimated 4 is here! Check out our [documentation page](https://docs.swmansion.com/react-native-reanimated/) for more information
6+
7+
### Nightly CI state
8+
9+
[![NPM Reanimated publish nightly](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-reanimated-publish-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-reanimated-publish-nightly.yml)
10+
[![Lint clang-tidy [Nightly]](https://github.com/software-mansion/react-native-reanimated/actions/workflows/lint-clang-tidy-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/lint-clang-tidy-nightly.yml)
11+
[![Reanimated compatibility check](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-compatibility-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-compatibility-check-nightly.yml)
12+
[![Use frameworks Reanimated build check [Nightly]](https://github.com/software-mansion/react-native-reanimated/actions/workflows/use-frameworks-reanimated-build-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/use-frameworks-reanimated-build-check-nightly.yml)
13+
[![React Native nightly Reanimated build check](https://github.com/software-mansion/react-native-reanimated/actions/workflows/react-native-nightly-reanimated-build-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/react-native-nightly-reanimated-build-check-nightly.yml)
14+
[![Expo DevClient build check](https://github.com/software-mansion/react-native-reanimated/actions/workflows/expo-devclient-build-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/expo-devclient-build-check-nightly.yml)
15+
[![Reanimated TypeScript compatibility test](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-typescript-compatibility-test-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-typescript-compatibility-test-nightly.yml)
16+
[![Windows hosted app Reanimated build check](https://github.com/software-mansion/react-native-reanimated/actions/workflows/windows-hosted-app-reanimated-build-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/windows-hosted-app-reanimated-build-check-nightly.yml)
17+
[![URL validation](https://github.com/software-mansion/react-native-reanimated/actions/workflows/url-validation-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/url-validation-nightly.yml)
18+
19+
## Installation
20+
21+
Check out the [installation](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/#installation) section of our docs for the detailed installation instructions.
22+
23+
## Compatibility
24+
25+
React Native Reanimated 4.x supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page) and three latest React Native versions.
26+
27+
If your app still runs on the old architecture, please consider adopting the New Architecture or stay with latest 3.x release.
28+
29+
## Documentation
30+
31+
Check out our dedicated documentation page for info about this library, API reference and more: [https://docs.swmansion.com/react-native-reanimated/](https://docs.swmansion.com/react-native-reanimated/)
32+
33+
## License
34+
35+
Reanimated library is licensed under [The MIT License](LICENSE).
36+
37+
## Credits
38+
39+
This project has been built and is maintained thanks to the support from [Shopify](https://shopify.com), [Expo.io](https://expo.io) and [Software Mansion](https://swmansion.com)
40+
41+
[![shopify](https://avatars1.githubusercontent.com/u/8085?v=3&s=100 'Shopify.com')](https://shopify.com)
42+
[![expo](https://avatars2.githubusercontent.com/u/12504344?v=3&s=100 'Expo.io')](https://expo.io)
43+
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-reanimated-github 'Software Mansion')](https://swmansion.com)
44+
45+
## Community Discord
46+
47+
[Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about Reanimated or other Software Mansion libraries.
48+
49+
## Reanimated is created by Software Mansion
50+
51+
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=reanimated&utm_medium=readme).

packages/react-native-reanimated/package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@
3636
"type:check:strict:app": "yarn workspace common-app type:check:strict",
3737
"build": "yarn workspace react-native-worklets build && bob build",
3838
"circular-dependency-check": "yarn madge --extensions js,jsx --circular lib",
39-
"prepack": "cp ../../README.md ./README.md",
40-
"postpack": "rm ./README.md",
4139
"tree-shake:check:web": "yarn is-tree-shakable --resolution web"
4240
},
4341
"main": "lib/module/index",

packages/react-native-worklets/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
![header](https://github.com/user-attachments/assets/41b37472-e55a-4c54-9064-31258e03870c)
1+
<img src="https://github.com/user-attachments/assets/41b37472-e55a-4c54-9064-31258e03870c" alt="React Native Worklets by Software Mansion" width="100%">
22

33
### The React Native multithreading library
44

5-
React Native Worklets is a library that allows you to run JavaScript code in parallel on multiple threads and runtimes.
5+
React Native Worklets is a library that allows you to run JavaScript code in parallel on multiple threads and runtimes, without writing any native code.
66

7-
While the library is in transitional period where we hone the API, all its features are functionally stable and ready to use in production.
7+
## Nightly CI state
8+
9+
[![NPM Worklets publish [Nightly]](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-worklets-publish-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-worklets-publish-nightly.yml)
10+
[![Lint clang-tidy [Nightly]](https://github.com/software-mansion/react-native-reanimated/actions/workflows/lint-clang-tidy-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/lint-clang-tidy-nightly.yml)
11+
[![Expo DevClient build check](https://github.com/software-mansion/react-native-reanimated/actions/workflows/expo-devclient-build-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/expo-devclient-build-check-nightly.yml)
12+
[![Worklets Bundle Mode build check [Nightly]](https://github.com/software-mansion/react-native-reanimated/actions/workflows/worklets-bundle-mode-build-check-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/worklets-bundle-mode-build-check-nightly.yml)
13+
[![URL validation](https://github.com/software-mansion/react-native-reanimated/actions/workflows/url-validation-nightly.yml/badge.svg)](https://github.com/software-mansion/react-native-reanimated/actions/workflows/url-validation-nightly.yml)
814

915
## Documentation
1016

0 commit comments

Comments
 (0)