Skip to content

Commit 8e410f2

Browse files
committed
README is updated
1 parent 07bbd2f commit 8e410f2

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img alt="React Native Library Boilerplate" src="https://github.com/WrathChaos/react-native-library-boilerplate/blob/master/assets/logo.png" width="1050"/>
1+
<img alt="React Native Library Boilerplate" src="assets/logo.png" width="1050"/>
22

33

44
[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/react-native-library-boilerplate)
@@ -15,15 +15,13 @@
1515

1616
<p align="center">
1717
<img alt="React Native Library Boilerplate"
18-
src="https://github.com/WrathChaos/react-native-library-boilerplate/blob/master/assets/Screenshots/JSLibraryBoilerplate.png" />
18+
src="assets/Screenshots/JSLibraryBoilerplate.png" />
1919
</p>
2020

21-
## Installation
21+
# Installation
2222

2323
Add the dependency:
2424

25-
### React Native:
26-
2725
```ruby
2826
npm i react-native-library-boilerplate
2927
```
@@ -37,29 +35,19 @@ npm i react-native-library-boilerplate
3735
"react-native": ">= 0.55.x",
3836
```
3937

40-
# Your Component Options
41-
42-
- Option 1 Component
43-
- Option 2 Component
38+
# Usage
4439

4540
## Import
4641

4742
```js
4843
import { Component1, Component2 } from "react-native-library-boilerplate";
4944
```
5045

51-
# Component1 Usage
46+
## Component1 Usage
5247

5348
```js
5449
<Component1 />
55-
```
56-
57-
58-
# Component2 Usage
59-
60-
```js
61-
<Component2 />
62-
```
50+
````
6351

6452

6553
### Configuration - Props
@@ -73,9 +61,9 @@ import { Component1, Component2 } from "react-native-library-boilerplate";
7361
| width | number | 150 | change the button's width |
7462
7563
76-
### ToDos
64+
### Future Plans
7765
78-
- [x] LICENSE
66+
- [x] ~~LICENSE~~
7967
- [ ] Write an article about the lib on Medium
8068
8169
# Change Log

0 commit comments

Comments
 (0)