Skip to content

Commit 7c6be7f

Browse files
authored
Update the readme
Fix the Travis build status indicator and update some wording
1 parent cfb0010 commit 7c6be7f

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# Aztec
1+
<h1><img align="center" width=50px height=50px src="https://github.com/wordpress-mobile/AztecEditor-iOS/raw/develop/RepoAssets/aztec.png" alt="Aztec Logo'"/>&nbsp;Aztec: Native HTML Editor for Android</h1>
22

3-
4-
[![Build Status](https://travis-ci.org/wordpress-mobile/WordPress-Aztec-Android.svg?branch=develop)](https://travis-ci.org/wordpress-mobile/WordPress-Aztec-Android)
3+
[![Build Status](https://travis-ci.org/wordpress-mobile/AztecEditor-Android.svg?branch=develop)](https://travis-ci.org/wordpress-mobile/AztecEditor-Android)
54
[![BuddyBuild](https://dashboard.buddybuild.com/api/statusImage?appID=5800168c52aea90100a973ed&branch=develop&build=latest)](https://dashboard.buddybuild.com/apps/5800168c52aea90100a973ed/build/latest)
65

7-
Aztec (extend EditText) is a rich text editor component for writing HTML
6+
Aztec (which extends EditText) is a rich-text editor component for writing HTML
87
documents in Android.
98

10-
Support Android 4.0+
9+
Supports Android 4.0+
1110

12-
# Build and test
11+
## Build and test
1312

1413
Build the library, build the example project and run unit tests:
1514

@@ -23,19 +22,21 @@ Run unit tests only:
2322
$ ./gradlew test
2423
```
2524

26-
Note: there is no instrumentation tests at the moment.
25+
Note: There are no instrumentation tests at the moment.
26+
27+
## Integrating Aztec in your project
2728

28-
# Integrate in your project
29+
The library is not ready for prime time yet, so it's not published on Maven
30+
Central. Currently the library is distributed as an [alpha build](https://github.com/wordpress-mobile/AztecEditor-Android/releases).
2931

30-
The library is not ready for prime time yet, so it's not distributed on maven
31-
central. Brave developers can either use the project as a source distribution
32-
or have fun with jitpack at their own risk:
32+
Brave developers can either use the project as a source distribution
33+
or have fun with JitPack at their own risk:
3334

3435
```gradle
3536
compile ('com.github.wordpress-mobile.WordPress-Aztec-Android:aztec:develop-SNAPSHOT')
3637
```
3738

38-
When Aztec is ready, we'll publish the artifact in maven.
39+
When Aztec is ready, we'll publish the artifact in Maven.
3940

4041
## Reference
4142

0 commit comments

Comments
 (0)