Skip to content

Commit 059d335

Browse files
authored
Update README.md
1 parent 8f7e7f6 commit 059d335

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11

2-
# react-native-config-reader
2+
# 🛠 react-native-config-reader
33

4-
## Getting started
4+
react-native-config-reader is a native library which make it easy to access all the native code's build configurations from JS.
55

6-
`$ npm install react-native-config-reader --save`
6+
## Installation
77

8-
### Mostly automatic installation
8+
1. `$ npm install react-native-config-reader --save` or `$ yarn add react-native-config-reader`
9+
10+
2. `$ react-native link react-native-config-reader`
11+
12+
13+
See [manual installation](#manual-installation) below if you have issues with `react-native link`.
14+
15+
## Usage
16+
```javascript
17+
import RNConfigReader from 'react-native-config-reader';
18+
19+
RNConfigReader.;
20+
```
921

10-
`$ react-native link react-native-config-reader`
1122

1223
### Manual installation
1324

@@ -35,19 +46,15 @@
3546
```
3647

3748
#### Windows
38-
[Read it! :D](https://github.com/ReactWindows/react-native)
49+
[Read it!](https://github.com/ReactWindows/react-native)
3950

4051
1. In Visual Studio add the `RNConfigReader.sln` in `node_modules/react-native-config-reader/windows/RNConfigReader.sln` folder to their solution, reference from their app.
4152
2. Open up your `MainPage.cs` app
4253
- Add `using Config.Reader.RNConfigReader;` to the usings at the top of the file
4354
- Add `new RNConfigReaderPackage()` to the `List<IReactPackage>` returned by the `Packages` method
4455

4556

46-
## Usage
47-
```javascript
48-
import RNConfigReader from 'react-native-config-reader';
57+
## License
58+
MIT © Chanaka Athurugiriya 2019
4959

50-
// TODO: What to do with the module?
51-
RNConfigReader;
52-
```
53-
60+

0 commit comments

Comments
 (0)