Skip to content

Commit a086da4

Browse files
authored
Update README.md
1 parent cde87a9 commit a086da4

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[![npm version](https://badge.fury.io/js/jsc-android.svg)](https://badge.fury.io/js/jsc-android)
2-
[![CircleCI](https://circleci.com/gh/react-native-community/jsc-android-buildscripts.svg?style=svg)](https://circleci.com/gh/react-native-community/jsc-android-buildscripts)
1+
[![npm version](https://badge.fury.io/js/%40kudo-ci%2Fjsc-android.svg)](https://badge.fury.io/js/%40kudo-ci%2Fjsc-android)
2+
![GitHub Actions CI](https://github.com/Kudo/jsc-android-buildscripts/workflows/.github/workflows/build_and_test.yml/badge.svg)
33

44
# JSC build scripts for Android
55

@@ -17,8 +17,8 @@ This project is based on [facebook/android-jsc](https://github.com/facebook/andr
1717
* Run `sdkmanager --list` and install all platforms, tools, buildtool v28.0.3, cmake (android images are not needed)
1818
* Set `$ANDROID_HOME` to the correct path (in ~/.bashrc or similar)
1919
* Set `export PATH=$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/tools/bin`
20-
* Android NDK r17c: download from [NDK Archives](https://developer.android.com/ndk/downloads/older_releases.html)
21-
* Set `export ANDROID_NDK=/path/to/android-ndk-r17c`
20+
* Android NDK r19c: download from [NDK Archives](https://developer.android.com/ndk/downloads/older_releases.html)
21+
* Set `export ANDROID_NDK=/path/to/android-ndk-r19c`
2222
* Make sure you have Ruby (>2.3), Python (>2.7), Git, SVN, gperf
2323

2424
## Build instructions
@@ -36,7 +36,7 @@ The library is packaged as a local Maven repository containing AAR files that in
3636

3737
## Distribution
3838

39-
JSC library built using this project is distributed over npm: [npm/jsc-android](https://www.npmjs.com/package/jsc-android).
39+
JSC library built using this project is distributed over npm: [npm/@kudo-ci/jsc-android](https://www.npmjs.com/package/@kudo-ci/jsc-android).
4040
The library is packaged as a local Maven repository containing AAR files that include the binaries.
4141
Please refer to the section below in order to learn how your app can consume this format.
4242

@@ -48,27 +48,29 @@ Follow steps below in order for your React Native app to use new version of JSC
4848

4949
### For React Native version 0.60 and newer
5050

51-
1. Update `jsc-android`:
51+
1. Use `@kudo-ci/jsc-android` to override stock `jsc-android`:
5252

5353
```
54-
yarn add jsc-android
54+
yarn add jsc-android@npm:@kudo-ci/jsc-android
5555
5656
# Or if you would like to try latest version
57-
# yarn add 'jsc-android@canary`
57+
# yarn add 'jsc-android@npm:@kudo-ci/jsc-android@next'
5858
5959
```
6060

6161
2. You're done, rebuild your app and enjoy updated version of JSC on android!
6262

6363
### For React Native version 0.59
6464

65-
1. Add `jsc-android` to the "dependencies" section in your `package.json`:
66-
```diff
67-
dependencies {
68-
+ "jsc-android": "241213.x.x",
65+
1. Add `@kudo-ci/jsc-android`:
66+
6967
```
68+
yarn add jsc-android@npm:@kudo-ci/jsc-android
7069
71-
then run `npm install` or `yarn` (depending on which npm client you use) in order for the new dependency to be installed in `node_modules`
70+
# Or if you would like to try latest version
71+
# yarn add 'jsc-android@npm:@kudo-ci/jsc-android@next'
72+
73+
```
7274

7375
2. Modify `android/build.gradle` file to add the new local maven repository packaged in the `jsc-android` package to the search path:
7476
```diff
@@ -94,7 +96,7 @@ allprojects {
9496

9597
dependencies {
9698
+ // Make sure to put android-jsc at the top
97-
+ implementation "org.webkit:android-jsc:r241213"
99+
+ implementation "org.webkit:android-jsc:+"
98100
+
99101
compile fileTree(dir: "libs", include: ["*.jar"])
100102
implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
@@ -118,13 +120,15 @@ android {
118120

119121
### For React Native version 0.58 below
120122

121-
1. Add `jsc-android` to the "dependencies" section in your `package.json`:
122-
```diff
123-
dependencies {
124-
+ "jsc-android": "241213.x.x",
123+
1. Add `@kudo-ci/jsc-android`:
124+
125125
```
126+
yarn add jsc-android@npm:@kudo-ci/jsc-android
126127
127-
then run `npm install` or `yarn` (depending which npm client you use) in order for the new dependency to be installed in `node_modules`
128+
# Or if you would like to try latest version
129+
# yarn add 'jsc-android@npm:@kudo-ci/jsc-android@next'
130+
131+
```
128132

129133
2. Modify `android/build.gradle` file to add new local maven repository packaged in the `jsc-android` package to the search path:
130134
```diff
@@ -151,7 +155,7 @@ allprojects {
151155

152156
+configurations.all {
153157
+ resolutionStrategy {
154-
+ force 'org.webkit:android-jsc:r241213'
158+
+ force 'org.webkit:android-jsc:+'
155159
+ }
156160
+}
157161

@@ -189,7 +193,7 @@ For React Native version 0.59, replace original artifact id with `android-jsc-in
189193

190194
dependencies {
191195
+ // Make sure to put android-jsc at the the first
192-
+ implementation "org.webkit:android-jsc-intl:r241213"
196+
+ implementation "org.webkit:android-jsc-intl:+"
193197
+
194198
compile fileTree(dir: "libs", include: ["*.jar"])
195199
implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"

0 commit comments

Comments
 (0)