Skip to content

Commit dbe93aa

Browse files
authored
docs: update README.md for improved clarity and formatting (#59)
- Enhanced the README with clearer feature descriptions and added icons for better visual appeal. - Updated sections for Requirements, Installation, Usage, Platform Support, Why NitroText, Development, Credits, and Contributing to improve readability and engagement. - Added a table for platform support details and refined the language for a more user-friendly experience.
1 parent e550832 commit dbe93aa

1 file changed

Lines changed: 26 additions & 29 deletions

File tree

README.md

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -24,34 +24,33 @@ https://github.com/user-attachments/assets/57f56b3f-3988-4235-af83-a5f2cfd82121
2424

2525
---
2626

27-
## Features
27+
## Features
2828

29-
- Works on both iOS and Android(currently fallback to RN `Text` on Android)
30-
- Native iOS rendering with smooth selection.
31-
- Nested fragments merge into a single native text view
32-
- Rendering Markdown and HTML (coming soon).
33-
- Supports only the New Architecture
29+
- 📱 Works on both iOS and Android with full native support
30+
- ⚡️ Native iOS and Android rendering with smooth selection
31+
- 🌐 HTML rendering support (Markdown coming soon)
32+
- 🏗️ Supports only the New Architecture
3433

35-
## Requirements
34+
## 📋 Requirements
3635

37-
- React Native v0.78.0 or higher (Fabric/Nitro Views)
38-
- Node 18+ (Node 20+ recommended)
36+
- ⚛️ React Native v0.78.0 or higher (Fabric/Nitro Views)
37+
- 🟢 Node 18+ (Node 20+ recommended)
3938

40-
## Installation
39+
## 📦 Installation
4140

4241
```bash
4342
yarn add react-native-nitro-text react-native-nitro-modules
4443
```
4544

46-
iOS
45+
**iOS**
4746

4847
```bash
4948
cd ios && pod install && cd ..
5049
```
5150

52-
Thats it. You can now use the `NitroText` component in your app.
51+
That's it! 🎉 You can now use the `NitroText` component in your app.
5352

54-
## Usage
53+
## 💻 Usage
5554

5655
```tsx
5756
import { NitroText as Text } from 'react-native-nitro-text'
@@ -65,10 +64,6 @@ export function Title() {
6564
}
6665
```
6766

68-
## Selection
69-
70-
iOS uses native selection. On Android, NitroText currently falls back to React Native `Text`.
71-
7267
```tsx
7368
import { NitroText as Text } from 'react-native-nitro-text'
7469

@@ -83,25 +78,27 @@ export function SelectionExample() {
8378
}
8479
```
8580

86-
## Platform Support
81+
## 🚀 Platform Support
8782

88-
- iOS
89-
- Android - At the moment `NitroText` fallback to RN `Text`.
83+
| Platform | Text Selection | HTML Rendering | Markdown Rendering |
84+
|----------|----------------|----------------|-------------------|
85+
| 🍎 **iOS** ||| 🚧 Coming Soon |
86+
| 🤖 **Android** ||| 🚧 Coming Soon |
9087

91-
## Why NitroText?
88+
## 💡 Why NitroText?
9289

93-
Custom native text view with minimal JS overhead and native iOS selection. Great for heavy/nested styled text and large lists. It's a drop-in replacement for RN `Text` component.
90+
Custom native text view with minimal JS overhead and native selection on both iOS and Android. Great for heavy/nested styled text and large lists. It's a drop-in replacement for RN `Text` component. ⚡️
9491

95-
## Development
92+
## 🛠️ Development
9693

97-
- `bun run build` — typecheck and build the package
98-
- `bun run codegen` — regenerate codegen outputs
99-
- Example app in `example/`
94+
- 🔨 `bun run build` — typecheck and build the package
95+
- 🔄 `bun run codegen` — regenerate codegen outputs
96+
- 📱 Example app in `example/`
10097

101-
## Credits
98+
## 🙏 Credits
10299

103100
Bootstrapped with [create-nitro-module](https://github.com/patrickkabwe/create-nitro-module).
104101

105-
## Contributing
102+
## 🤝 Contributing
106103

107-
PRs welcome! Please open an issue first for major changes.
104+
PRs welcome! 💖 Please open an issue first for major changes.

0 commit comments

Comments
 (0)