Skip to content

Commit 5718b8f

Browse files
authored
docs: Update README.md (#263)
## Description This PR updates colors of badges and some information in the README file.
1 parent 54bb95d commit 5718b8f

File tree

2 files changed

+78
-17
lines changed

2 files changed

+78
-17
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,44 @@ This project uses GitHub to host code, track issues and feature requests, and ac
3333
1. Fork the repo and create your branch from `main`
3434
2. Clone your forked repo
3535
3. Set up the development environment:
36-
- Run `yarn` in the repo root to install dependencies
37-
- For iOS: Run `yarn example:fabric pod`
36+
37+
```bash
38+
yarn
39+
yarn pod # iOS only
40+
```
41+
3842
4. Start development:
39-
- Run `yarn example:fabric start` to start metro bundler
40-
- Build project:
41-
- Using IDE: Open in Xcode/Android Studio
42-
- Using command line:
43-
- Android: `yarn example:fabric android`
44-
- iOS: `yarn example:fabric ios`
43+
44+
```bash
45+
cd example/fabric # or any other example
46+
yarn start
47+
```
48+
49+
Available example apps:
50+
51+
- `fabric` - React Native Fabric example
52+
- `paper` - React Native Paper example
53+
- `expo` - Expo example
54+
- `web` - Web example
55+
56+
You can also run commands from root using `yarn example:<name> <command>`, e.g.:
57+
58+
```bash
59+
yarn example:fabric start
60+
yarn example:paper android
61+
yarn example:expo ios
62+
```
63+
64+
Build and run:
65+
66+
- iOS: `yarn ios` or build in Xcode
67+
- Android: `yarn android` or build in Android Studio
68+
4569
5. Make your changes
4670
6. If you've changed APIs, update the documentation
47-
7. Make sure your code lints
48-
8. Update the example project if needed
49-
9. Submit that pull request!
71+
7. Make sure your code passes prettier/eslint/typescript checks
72+
8. Update or create a new example in the example app if applicable
73+
9. Submit that pull request
5074

5175
> [!TIP]
5276
> All example commands shown above can also be run with the **Old Architecture (Paper)** example app by replacing `example:fabric` with `example:paper` in the commands.

README.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
[Documentation](https://react-native-sortables-docs.vercel.app/) | [Examples](https://react-native-sortables-docs.vercel.app/grid/examples) | [Contributing](./CONTRIBUTING.md)
1212

13-
![npm](https://img.shields.io/npm/dw/react-native-sortables?color=ffd53e)
14-
![GitHub issues](https://img.shields.io/github/issues/MatiPl01/react-native-sortables?color=ffd53e)
15-
![GitHub contributors](https://img.shields.io/github/contributors/MatiPl01/react-native-sortables?color=ffd53e)
16-
![GitHub Release Date](https://img.shields.io/github/release-date/MatiPl01/react-native-sortables?color=ffd53e)
17-
![GitHub](https://img.shields.io/github/license/MatiPl01/react-native-sortables?color=ffd53e)
13+
![npm](https://img.shields.io/npm/dw/react-native-sortables?color=36877F)
14+
![GitHub issues](https://img.shields.io/github/issues/MatiPl01/react-native-sortables?color=36877F)
15+
![GitHub contributors](https://img.shields.io/github/contributors/MatiPl01/react-native-sortables?color=36877F)
16+
![GitHub Release Date](https://img.shields.io/github/release-date/MatiPl01/react-native-sortables?color=36877F)
17+
![GitHub](https://img.shields.io/github/license/MatiPl01/react-native-sortables?color=36877F)
1818

1919
![GitHub forks](https://img.shields.io/github/forks/MatiPl01/react-native-sortables?style=social)
2020
![GitHub Repo stars](https://img.shields.io/github/stars/MatiPl01/react-native-sortables?style=social)
@@ -72,7 +72,7 @@ yarn add react-native-sortables
7272

7373
This library is built with:
7474

75-
- [react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/) (version 3.x)
75+
- [react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/) (version 3.x, 4.x)
7676
- [react-native-gesture-handler](https://docs.swmansion.com/react-native-gesture-handler/) (version 2.x)
7777

7878
Make sure to follow their installation instructions for your project.
@@ -121,6 +121,43 @@ const styles = StyleSheet.create({
121121

122122
For detailed usage and examples, check out the [Documentation](https://react-native-sortables-docs.vercel.app/).
123123

124+
## Local Library Development
125+
126+
1. Clone and setup:
127+
128+
```bash
129+
git clone https://github.com/MatiPl01/react-native-sortables.git
130+
cd react-native-sortables
131+
yarn
132+
yarn pod # iOS only
133+
```
134+
135+
2. Start an example app:
136+
137+
```bash
138+
cd example/fabric # or any other example
139+
yarn start
140+
```
141+
142+
Available example apps:
143+
144+
- `fabric` - React Native Fabric example
145+
- `paper` - React Native Paper example
146+
- `expo` - Expo example
147+
- `web` - Web example
148+
149+
You can also run commands from the project root using the `yarn example:<name> <command>` syntax, e.g.:
150+
151+
```bash
152+
yarn example:fabric start
153+
yarn example:paper android
154+
yarn example:expo ios
155+
```
156+
157+
3. Build and run:
158+
- iOS: `yarn ios` or build in Xcode
159+
- Android: `yarn android` or build in Android Studio
160+
124161
## Contributing
125162

126163
Contributions are welcome! Please read the [Contributing Guide](./CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)