Skip to content

Commit 0b7a866

Browse files
committed
chore(doc): usage
1 parent 81eb6f5 commit 0b7a866

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
It allows you to easily use mars-xlog inside your React Native applications.
44

5+
[![Node.js Package](https://github.com/Flickering-AI/react-native-xlog-jsi/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/Flickering-AI/react-native-xlog-jsi/actions/workflows/npm-publish.yml)
6+
57
## Installation
68

79
```sh
@@ -10,7 +12,15 @@ yarn add react-native-xlog-jsi
1012

1113
## Usage
1214

13-
No action needed.
15+
```javascript
16+
import Xlog from 'react-native-xlog-jsi';
17+
18+
// init
19+
const xlog = new Xlog();
20+
21+
// flush before pull xlog file
22+
Xlog.appenderFlush();
23+
```
1424

1525
## Contributing
1626

0 commit comments

Comments
 (0)