Skip to content

Commit 98ae9fe

Browse files
committed
Update integration instructions
1 parent 86c0a29 commit 98ae9fe

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Aztec.with(visualEditor, sourceEditor, toolbar, context)
6060
.setVideoThumbnailGetter(GlideVideoThumbnailLoader(context))
6161
```
6262

63-
For more options, such as edit history, listeners and plugins please refer to the [demo app implementation](https://github.com/wordpress-mobile/AztecEditor-Android/blob/9fdc1958ca1e1ad5de6fba15dabe251bcf0fc7b6/app/src/main/kotlin/org/wordpress/aztec/demo/MainActivity.kt#L331-L346).
63+
For more options, such as edit history, listeners and plugins please refer to the [demo app implementation](https://github.com/wordpress-mobile/AztecEditor-Android/blob/develop/app/src/main/kotlin/org/wordpress/aztec/demo/MainActivity.kt).
6464

6565
## Build and test
6666

@@ -98,18 +98,27 @@ $ ./gradlew cAT
9898

9999
## Integrating Aztec in your project
100100

101-
The library is not ready for prime time yet, so it's not published on Maven
102-
Central. Currently the library is distributed as an [alpha build](https://github.com/wordpress-mobile/AztecEditor-Android/releases).
101+
You can import Aztec into your project using Jitpack:
102+
```gradle
103+
repositories {
104+
maven { url "https://jitpack.io" }
105+
}
106+
```
107+
```gradle
108+
dependencies {
109+
api ('com.github.wordpress-mobile.WordPress-Aztec-Android:aztec:v1.3.1')
110+
}
111+
```
103112

104113
Brave developers can either use the project as a source distribution
105-
or have fun with JitPack at their own risk:
114+
or have fun with the latest snapshot at their own risk:
106115

107116
```gradle
108-
compile ('com.github.wordpress-mobile.WordPress-Aztec-Android:aztec:develop-SNAPSHOT')
117+
dependencies {
118+
api ('com.github.wordpress-mobile.WordPress-Aztec-Android:aztec:develop-SNAPSHOT')
119+
}
109120
```
110121

111-
When Aztec is ready, we'll publish the artifact in Maven.
112-
113122
## Code formatting
114123

115124
We use [ktlint](https://github.com/shyiko/ktlint) for Kotlin linting. You can run ktlint using `./gradlew ktlint`, and you can also run `./gradlew ktlintFormat` for auto-formatting. There is no IDEA plugin (like Checkstyle's) at this time.

0 commit comments

Comments
 (0)