Skip to content

Commit fe0ab44

Browse files
committed
docs: Update docs
1 parent f0e893e commit fe0ab44

File tree

7 files changed

+44
-410
lines changed

7 files changed

+44
-410
lines changed

CONTRIBUTING.md

-4
Original file line numberDiff line numberDiff line change
@@ -98,16 +98,12 @@ We follow the [conventional commits specification](https://www.conventionalcommi
9898
- `test`: adding or updating tests, e.g. add integration tests using detox.
9999
- `chore`: tooling changes, e.g. change CI config.
100100

101-
Our pre-commit hooks verify that your commit message matches this format when committing.
102-
103101
### Linting and tests
104102

105103
[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
106104

107105
We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
108106

109-
Our pre-commit hooks verify that the linter and tests pass when committing.
110-
111107
### Publishing to npm
112108

113109
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.

README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# react-native-worklets-core
1+
<a href="https://margelo.io">
2+
<img src="./img/banner.svg" width="100%" />
3+
</a>
24

3-
[Worklet](docs/WORKLETS.md) runner for React Native.
5+
# 🧵 react-native-worklets-core
6+
7+
A [Worklet](docs/WORKLETS.md) runner for React Native.
48

59
```js
610
const worklet = () => {
@@ -9,6 +13,9 @@ const worklet = () => {
913
}
1014
```
1115

16+
> [!NOTE]
17+
> In most cases, react-native-worklets-core shouldn't be used as a standalone dependency but rather as a peer-dependency for other modules such as [react-native-vision-camera](https://github.com/mrousavy/react-native-vision-camera), [react-native-wishlist](https://github.com/margelo/react-native-wishlist), or [react-native-skia](https://github.com/Shopify/react-native-skia).
18+
1219
## Installation
1320

1421
1. Install the library from npm:
@@ -45,3 +52,4 @@ MIT
4552
## Credits
4653

4754
* Credits go to [Software Mansion](https://swmansion.com) for introducing the concept of [Worklets](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets) in [Reanimated v2](https://github.com/software-mansion/react-native-reanimated). This library is inspired by Reanimated v2 with a few structural changes to the Worklets architecture to make it more flexible for different use-cases.
55+
* Credits go to [Christian Falch](https://github.com/chrfalch) for building the initial version of this library.

example/ios/Podfile.lock

+3-3
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ PODS:
329329
- React-jsinspector (0.71.2)
330330
- React-logger (0.71.2):
331331
- glog
332-
- react-native-worklets-core (0.1.0):
332+
- react-native-worklets-core (0.2.0):
333333
- React
334334
- React-callinvoker
335335
- React-Core
@@ -608,7 +608,7 @@ SPEC CHECKSUMS:
608608
React-jsiexecutor: c7e028406112db456ac3cf5720d266bc7bc20938
609609
React-jsinspector: ea8101acf525ec08b2d87ddf0637d45f8e3b4148
610610
React-logger: 97987f46779d8dd24656474ad0c43a5b459f31d6
611-
react-native-worklets-core: c7576ad4ad0f030ff41e8d74ad0077c96054a6c1
611+
react-native-worklets-core: 7ad416a8965086b98b07964f7f6932560a54a14c
612612
React-perflogger: c7ccda3d1d1da837f7ff4e54e816022a6803ee87
613613
React-RCTActionSheet: 01c125aebbad462a24228f68c584c7a921d6c28e
614614
React-RCTAnimation: 5277a9440acffc4a5b7baa6ae3880fe467277ae6
@@ -628,4 +628,4 @@ SPEC CHECKSUMS:
628628

629629
PODFILE CHECKSUM: c46eeadf62eacc6cce37103dce03f2706173cfb1
630630

631-
COCOAPODS: 1.11.3
631+
COCOAPODS: 1.12.1

img/banner.svg

+13
Loading

lefthook.yml

-16
This file was deleted.

package.json

-8
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,11 @@
7575
"registry": "https://registry.npmjs.org/"
7676
},
7777
"devDependencies": {
78-
"@commitlint/config-conventional": "^17.0.2",
79-
"@evilmartians/lefthook": "^1.2.2",
8078
"@react-native-community/eslint-config": "^3.0.2",
8179
"@release-it/conventional-changelog": "^5.0.0",
8280
"@types/jest": "^28.1.2",
8381
"@types/react": "~18.0.27",
8482
"clang-format": "^1.8.0",
85-
"commitlint": "^17.0.2",
8683
"del-cli": "^5.0.0",
8784
"eslint": "^8.4.1",
8885
"eslint-config-prettier": "^8.5.0",
@@ -114,11 +111,6 @@
114111
"<rootDir>/lib/"
115112
]
116113
},
117-
"commitlint": {
118-
"extends": [
119-
"@commitlint/config-conventional"
120-
]
121-
},
122114
"release-it": {
123115
"git": {
124116
"commitMessage": "chore: release ${version}",

0 commit comments

Comments
 (0)