Merge pull request #112 from friederbluemle/update-ci

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: ci
+on: [push, pull_request]
+jobs:
+  build-android:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - run: npm i -g electrode-native && ern
+      - run: yarn
+      - working-directory: android/
+        run: ./gradlew createAndPublishErnDevContainer
+      - working-directory: android/
+        run: ./gradlew assembleDebug test lint
+  build-ios:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - run: npm i -g electrode-native && ern
+      - run: yarn
+      - run: yarn createiOSContainer
+      - working-directory: ios/moviesreloadedMiniApp/
+        run: xcodebuild -project "ErnRunner.xcodeproj" -scheme "ErnRunner" -destination "platform=iOS Simulator,name=iPhone 11,OS=13.4.1"

README.md

@@ -2,13 +2,35 @@
 
 [![Actions Status][1]][2]
 
-Native implementation for the [`ernnavigation-api`](https://github.com/electrode-io/ern-navigation-api#electrode-native-navigation-api)
+Native implementation of [`ernnavigation-api`][3].
 
-Please run `yarn createiOSContainer` to create the iOS Container at
-`ios/container`. Afterwards, in Xcode, you can either build the ElectrodeApiImpl
-project at `ios/ElectrodeApiImpl.xcodeproj` or you can run the
-moviesreloadedMiniApp at `/ios/moviesreloadedMiniApp/ErnRunner.xcodeproj` to try
-Electrode Native Navigation on iOS side.
+## Getting Started
 
-[1]: https://github.com/electrode-io/ernnavigation-api-impl-native/workflows/main/badge.svg
+### Android
+
+Inside the `android/` directory, run the following command:
+
+```sh
+./gradlew createAndPublishErnDevContainer
+```
+
+The container will be created in a temporary directory and published to the
+local Maven repository (`~/.m2`), from where it will be consumed by the library
+project.
+
+### iOS
+
+Create the iOS Container:
+
+```sh
+yarn createiOSContainer
+```
+
+After opening the `ios/` directory in Xcode (`xed ios`), you can either build
+the ElectrodeApiImpl project at `ios/ElectrodeApiImpl.xcodeproj` or you can run
+the moviesreloadedMiniApp at `/ios/moviesreloadedMiniApp/ErnRunner.xcodeproj`
+to try Electrode Native Navigation on iOS side.
+
+[1]: https://github.com/electrode-io/ernnavigation-api-impl-native/workflows/ci/badge.svg
 [2]: https://github.com/electrode-io/ernnavigation-api-impl-native/actions
+[3]: https://github.com/electrode-io/ern-navigation-api#electrode-native-navigation-api