Skip to content

Commit 2d7c4db

Browse files
committed
docs: updated readme file
1 parent 4261bbc commit 2d7c4db

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,50 @@ High-quality HTML to PDF conversion for React Native with vector-based header/fo
1111
- ✅ Custom margins
1212
- ✅ iOS and Android support
1313
- ✅ Built with [Nitro Modules](https://nitro.margelo.com/) for optimal performance
14+
- ✅ No Backend Required - Works offline
15+
- ✅ Privacy-First - No data sent to servers
16+
- ✅ Zero Cloud Costs - Local PDF generation
17+
18+
## Use Cases
19+
20+
This library is perfect for:
21+
22+
- **📄 Invoices and Receipts** - Professional documents with company headers and page numbers
23+
- **📊 Reports** - Multi-page reports with consistent branding
24+
- **📋 Contracts** - Legal documents with headers, footers, and pagination
25+
- **🎓 Certificates** - Custom-designed certificates with vector quality
26+
- **💳 Statements** - Bank statements, account summaries, etc.
27+
- **🎫 Tickets and Passes** - Event tickets, boarding passes, etc.
28+
- **📑 Documentation** - Technical manuals, user guides
29+
- **💼 Business Documents** - Proposals, quotes, presentations
1430

1531
## Installation
1632

1733
```sh
1834
npm install react-native-nitro-html-pdf react-native-nitro-modules
1935
```
2036

37+
Or with yarn:
38+
39+
```sh
40+
yarn add react-native-nitro-html-pdf react-native-nitro-modules
41+
```
42+
2143
> `react-native-nitro-modules` is required as this library relies on [Nitro Modules](https://nitro.margelo.com/).
2244
45+
### Android Setup
46+
47+
Add to your `MainActivity.kt`:
48+
49+
```kotlin
50+
import com.margelo.nitro.nitrohtmlpdf.NitroHtmlPdf
51+
52+
override fun onCreate(savedInstanceState: android.os.Bundle?) {
53+
super.onCreate(savedInstanceState)
54+
NitroHtmlPdf.appContext = applicationContext
55+
}
56+
```
57+
2358
## Usage
2459

2560
### Basic Example

0 commit comments

Comments
 (0)