Skip to content

Commit 19bfb36

Browse files
authored
Merge pull request #494 from Countly/readme-update
Readme update
2 parents b509586 + 1c8640b commit 19bfb36

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

example/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,23 @@ Please refer to the React Native [documentation](https://reactnative.dev/docs/se
77

88
## Automatic App Creation
99

10-
If you have setted up your environment correctly then you should be able to run the example app by running the create_app.py provided
10+
If you have set up your environment correctly then you should be able to run the example app by running the create_app.py provided
1111

1212
```bash
1313
python create_app.py
1414
```
1515

16-
Then you can start the app by:
16+
It will give you an option to setup Expo or Create React App as the template.
17+
18+
Then you can start the app by going to the created folder (AwesomeProject or ExpoProject) and:
1719

1820
```bash
1921
npx react-native run-android
2022
# or npx react-native run-ios
23+
24+
# or for Expo's development mode
25+
npx expo run android
26+
# or npx expo run ios
2127
```
2228

2329
## Manual App Creation
@@ -26,9 +32,7 @@ For more information you can check [here](https://reactnative.dev/docs/getting-s
2632
If you want to set up the app manually instead, then you should run:
2733

2834
```bash
29-
npx @react-native-community/cli@latest init AwesomeProject --version 0.74.0
30-
# Version here may vary but make sure to use a stabile version of the react-native
31-
# Latest versions can experience issues because of unstability
35+
npx @react-native-community/cli@latest init AwesomeProject
3236
```
3337

3438
Then copy the contents of CountlyRNExample into the AwesomeProject and let it replace the App.tsx there.
@@ -48,15 +52,15 @@ Finally you can run:
4852
npx react-native run-android
4953
# or npx react-native run-ios
5054
```
55+
5156
## Debugging
5257
For possible java issues you can try some of the following options:
5358
- changing the IDE settings.
5459
- changing the JAVA_HOME environment variable.
5560
- changing `org.gradle.java.home` in `gradle.properties`.
5661

57-
Currently Java 17 and bigger is needed.
58-
5962
For a ninja issue about path length you might want to download and point to a specific ninja version:
63+
6064
```java
6165
// under app level build.gradle's defaultConfig
6266
externalNativeBuild {
@@ -70,7 +74,7 @@ For an issue with the recent version of React Native (0.76) about safe area cont
7074

7175
## iOS Push Notification Documentation
7276

73-
Note: This documentation assumes, that you have created necessary certficate, have proper app bundle id.
77+
Note: This documentation assumes, that you have created necessary certificate, have proper app bundle id.
7478

7579
STEP 1: Make sure you have proper app bundle id and team selected.
7680

@@ -151,5 +155,5 @@ STEP 3: Updating NotificationService file
151155
152156
Note: Please make sure you check Deployment Target version of extension target is 10, not 10.3 (or whatever minor version Xcode set automatically). Otherwise users running iOS versions lower than Deployment Target value can not get rich push notifications.
153157

154-
Note: To send push messages to applications that are Debug build use Countly.messagingMode.DEVELOPMENT, for App Store built ones use Countly.messagingMode.PRODUCTION, and for TestFlight/Ad Hoc builds use Countly.messagingMode.ADHOC.
155-
158+
Note: To send push messages to applications that are Debug build use Countly.messagingMode.DEVELOPMENT, for App Store built ones use Countly.messagingMode.PRODUCTION, and for TestFlight/Ad Hoc builds use Countly.messagingMode.ADHOC.
159+

0 commit comments

Comments
 (0)