Skip to content

Commit 13a4c1b

Browse files
committed
convert adoc to md for npm publish
1 parent e97bf19 commit 13a4c1b

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[TOC]
1+
22

33
## Description
44

5-
This is link:https://github.com/facebook/react-native[react-native] wrapper for link:https://github.com/EspressifApp[ESP8266 ESPTOUCH Smart config]
5+
This is [https://github.com/facebook/react-native](react-native) wrapper for [https://github.com/EspressifApp](ESP8266 ESPTOUCH Smart config)
66

77
## Featues
88
* Support both IOS and Android
@@ -17,18 +17,18 @@ This is link:https://github.com/facebook/react-native[react-native] wrapper for
1717

1818
### Manual install
1919
#### iOS
20-
1. `npm install react-native-smartconfig@latest --save`
21-
2. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
22-
3. Go to `node_modules``react-native-smartconfig` and add `RCTSmartconfig.xcodeproj`
23-
4. In XCode, in the project navigator, select your project. Add `libRCTSmartconfig.a` to your project's `Build Phases``Link Binary With Libraries`
24-
5. Click `RCTSmartconfig.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` - mark as `recursive`.
25-
5. Run your project (`Cmd+R`)
20+
- `npm install react-native-smartconfig@latest --save`
21+
- In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
22+
- Go to `node_modules``react-native-smartconfig` and add `RCTSmartconfig.xcodeproj`
23+
- In XCode, in the project navigator, select your project. Add `libRCTSmartconfig.a` to your project's `Build Phases``Link Binary With Libraries`
24+
- Click `RCTSmartconfig.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` - mark as `recursive`.
25+
- Run your project (`Cmd+R`)
2626

2727

2828
#### Android
2929

30-
1. `npm install react-native-smartconfig@latest --save`
31-
2. Modify the ReactInstanceManager.builder() calls chain in `android/app/main/java/.../MainActivity.java` to include:
30+
- `npm install react-native-smartconfig@latest --save`
31+
- Modify the ReactInstanceManager.builder() calls chain in `android/app/main/java/.../MainActivity.java` to include:
3232

3333
```javascript
3434
import com.tuanpm.RCTSmartconfig; // import
@@ -39,14 +39,14 @@ import com.tuanpm.RCTSmartconfig; // import
3939
new RCTSmartconfigPackage() // for newest version of react-native
4040
```
4141

42-
3. Append the following lines to `android/settings.gradle` before `include ':app'`:
42+
- Append the following lines to `android/settings.gradle` before `include ':app'`:
4343

4444
```java
4545
include ':react-native-smartconfig'
4646
project(':react-native-smartconfig').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-smartconfig/android')
4747
```
4848

49-
4. Insert the following lines inside the dependencies block in `android/app/build.gradle`, don't missing `apply plugin:'java'` on top:
49+
- Insert the following lines inside the dependencies block in `android/app/build.gradle`, don't missing `apply plugin:'java'` on top:
5050

5151
```java
5252
compile project(':react-native-smartconfig')
@@ -74,7 +74,6 @@ buildscript {
7474

7575
## Usage
7676

77-
* Normal
7877
```javascript
7978
var Smartconfig = require('react-native').NativeModules.Smartconfig;
8079
Smartconfig.start({

0 commit comments

Comments
 (0)