Skip to content

Commit a33a1a5

Browse files
Update Readme
1 parent c1c0c2c commit a33a1a5

File tree

3 files changed

+72
-2
lines changed

3 files changed

+72
-2
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-native-ficus-ui-monorepo",
33
"private": true,
4-
"version": "2.0.1",
4+
"version": "2.0.2",
55
"engines": {
66
"node": ">= 22.0.0"
77
},
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<img src="apps/docs/static/img/banner.png" width="80%" alt="React Native Ficus UI banner" />
2+
3+
<br />
4+
5+
Ficus UI is a React Native UI library inspired by Chakra UI
6+
7+
## Requirements
8+
9+
This library now needs `react-native-gesture-handler` to be installed inside the React Native project.
10+
If you use Expo Go then you have nothing to do as Gesture Handler is integrated inside Expo SDK.
11+
But if you use a Bare React Native project, please follow those instructions in first : https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/installation/
12+
13+
## Installation
14+
15+
With pnpm :
16+
17+
```sh
18+
pnpm add react-native-ficus-ui
19+
```
20+
21+
With npm :
22+
23+
```sh
24+
npm install react-native-ficus-ui
25+
```
26+
27+
With yarn :
28+
29+
```sh
30+
yarn add react-native-ficus-ui
31+
```
32+
33+
Then, install the pods for iOS :
34+
35+
```sh
36+
cd ios && pod install
37+
```
38+
39+
## Usage
40+
41+
You need to wrap your root component inside FicusProvider component from react-native-ficus-ui.
42+
43+
```js title="index.js"
44+
import { AppRegistry } from 'react-native';
45+
import { FicusProvider } from 'react-native-ficus-ui';
46+
47+
import App from './src/App';
48+
49+
export default function Main() {
50+
return (
51+
<FicusProvider>
52+
<App />
53+
</FicusProvider>
54+
);
55+
}
56+
57+
AppRegistry.registerComponent('main', () => Main);
58+
```
59+
60+
## Contributing
61+
62+
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
63+
64+
## License
65+
66+
MIT
67+
68+
---
69+
70+
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

packages/react-native-ficus-ui/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"type": "module",
33
"name": "react-native-ficus-ui",
4-
"version": "2.0.1",
4+
"version": "2.0.2",
55
"contributors": [
66
{
77
"name": "Nicolas Torion",

0 commit comments

Comments
 (0)