-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build(docs): Update the readme (#144)
Signed-off-by: Ahmed Moussa <[email protected]>
- Loading branch information
Showing
3 changed files
with
49 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,15 @@ | ||
| # Apollo | ||
|
|
||
| [](http://kotlinlang.org) | ||
| [](https://github.com/input-output-hk/atala-prism-apollo/actions/workflows/pull-request.yml) | ||
| [](https://github.com/input-output-hk/atala-prism-apollo/actions/workflows/Deployment.yml) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| [](http://kotlinlang.org) | ||
| ![badge-license] | ||
| ![badge-latest-release] | ||
| [![semantic-release-kotlin]](https://github.com/semantic-release/semantic-release) | ||
|
|
||
| ![badge-platform-android] | ||
| ![badge-platform-ios] | ||
| ![badge-platform-jvm] | ||
| ![badge-platform-js] | ||
| ![badge-platform-js-node] | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -160,8 +159,7 @@ repositories { | |
| For dependencies | ||
| ```kotlin | ||
| dependencies { | ||
| val apolloVersion = ... // Latest Apollo Version | ||
| implementation("io.iohk.atala.prism.apollo:apollo:$apolloVersion") | ||
| implementation("io.iohk.atala.prism.apollo:apollo:<latest version>") | ||
| } | ||
| ``` | ||
|
|
@@ -174,7 +172,7 @@ Inside your `Package.swift` file, add the following | |
| dependencies: [ | ||
| .package( | ||
| url: "[email protected]:input-output-hk/atala-prism-apollo.git", | ||
| from: "latest version" | ||
| from: "<latest version>" | ||
| ) | ||
| ] | ||
| ``` | ||
|
|
@@ -211,35 +209,13 @@ Inside the `package.json` | |
| ```json | ||
| { | ||
| "dependencies": { | ||
| "@atala/apollo": "latest version of Apollo" | ||
| "@atala/apollo": "<latest version>" | ||
| } | ||
| } | ||
| ``` | ||
| ## How to use for another KMP (Kotlin Multiplatform) project | ||
| You need to do the following: | ||
| 1. You need to let Gradle know where to search for the Apollo package | ||
| 2. Import the packages in the common target as per your project needs | ||
| 1. Once you insert the import in the common target, it will automatically retrieve each supported target knowing that the currently only available targets are: | ||
| 3. You need to use the new iOS hierarchy system (In case they have an iOS target) | ||
| 4. You need to use the same Kotlin version used in our project | ||
| | Platform | Supported | | ||
| |------------------------------------------|--------------------| | ||
| | iOS x86 64 | :heavy_check_mark: | | ||
| | iOS Arm 64 | :heavy_check_mark: | | ||
| | iOS Simulator Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | JVM | :heavy_check_mark: | | ||
| | Android | :heavy_check_mark: | | ||
| | JS Browser | :heavy_check_mark: | | ||
| | NodeJS Browser | :heavy_check_mark: | | ||
| | macOS X86 64 | :heavy_check_mark: | | ||
| | macOS Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| **For the first, second & third point** we have two cases using Groovy and using Kotlin DSL | ||
| ### Using Groovy | ||
| In the project `build.gradle` | ||
|
|
@@ -258,7 +234,7 @@ kotlin { | |
| commonMain { | ||
| dependencies { | ||
| // This following is just an example you can import it as per you needs | ||
| implementation 'io.iohk.atala.prism.apollo:apollo:${latest version}' | ||
| implementation 'io.iohk.atala.prism.apollo:apollo:<latest version>' | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -288,8 +264,12 @@ kotlin { | |
| } | ||
| } | ||
| ``` | ||
| **For the third point** | ||
| You need to use Kotlin version `1.9.21`. | ||
| ## How to use for Scala project | ||
| ```scala | ||
| libraryDependencies += "io.iohk.atala.prism.apollo" % "apollo-jvm" % "<latest version>" | ||
| ``` | ||
| ## Usage | ||
|
|
@@ -309,3 +289,15 @@ This software is provided 'as-is', without any express or implied warranty. In n | |
| authors be held liable for any damages arising from the use of this software. Permission is granted | ||
| to anyone to use this software for any purpose, including commercial applications, and to alter it | ||
| and redistribute it freely. | ||
|
|
||
| <!-- TAG_VERSION --> | ||
| [badge-latest-release]: https://img.shields.io/badge/latest--release-1.2.10-blue.svg?style=flat | ||
| [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat | ||
| [semantic-release-kotlin]: https://img.shields.io/badge/semantic--release-kotlin-blue?logo=semantic-release | ||
|
|
||
| <!-- TAG_PLATFORMS --> | ||
| [badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat | ||
| [badge-platform-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat | ||
| [badge-platform-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat | ||
| [badge-platform-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat | ||
| [badge-platform-js-node]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ buildscript { | |
| mavenCentral() | ||
| } | ||
| dependencies { | ||
| classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.21") | ||
| classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.22") | ||
| classpath("com.android.tools.build:gradle:7.2.2") | ||
| classpath("org.jetbrains.dokka:dokka-base:1.9.10") | ||
| } | ||
|
|
@@ -74,6 +74,7 @@ allprojects { | |
| email.set("[email protected]") | ||
| organization.set("IOG") | ||
| roles.add("developer") | ||
| url.set("https://github.com/hamada147") | ||
| } | ||
| developer { | ||
| id.set("amagyar-iohk") | ||
|
|
||