Skip to content
This repository was archived by the owner on Jan 30, 2025. It is now read-only.

Commit 9ecdde4

Browse files
committed
update readme
1 parent fc12761 commit 9ecdde4

File tree

1 file changed

+3
-16
lines changed

1 file changed

+3
-16
lines changed

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
11
# react-native-improved
22

3-
Provides react-native components with different fixes (old architecture). The library patches the original react-native Android implementation of the Text component without building it from source.
3+
Provides different react-native iOS, Android and JS API fixes/PRs.
44

5-
Use the `TextImproved` component instead of `Text` to apply the following patches:
6-
7-
- TextImproved: Issue https://github.com/facebook/react-native/issues/39722
5+
- Text: Issue https://github.com/facebook/react-native/issues/39722
86

97
## Set-up
108

119
In package.json
1210

1311
```diff
1412
"scripts": {
15-
+ "postinstall": "./node_modules/react-native-improved/src/react_native_renderer_patch.sh"
13+
+ "postinstall": "yarn patch"
1614
}
1715
```
1816

1917
Then
2018

2119
## npm
2220

23-
**IMPORTANT**: to be used requires to patch the react-native-renderer for dev and prop as done in this [file](https://github.com/fabriziobertoglio1987/react-native-improved/blob/main/example/patches/react-native%2B0.73.0%2B001%2Bfix-renderer-text-runtime.patch) with patch package.
24-
2521
```sh
2622
npm install react-native-improved
2723
```
@@ -32,15 +28,6 @@ npm install react-native-improved
3228
yarn add react-native-improved
3329
```
3430

35-
## Usage
36-
37-
```js
38-
import { TextImproved } from 'react-native-improved';
39-
40-
// The TextImproved component includes several react-native fixes
41-
const MyComponent = (props) => <TextImproved>Fixed Text</TextImproved>;
42-
```
43-
4431
## Feature Requests
4532

4633
If you want to ask for additional features in this library, you can open an [issue](https://github.com/fabriziobertoglio1987/react-native-improved/issues). I follow-up with your request.

0 commit comments

Comments
 (0)