diff --git a/README.md b/README.md index 2230174be..469691d22 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ + + + # Kiwix-Android -[![Build Status](https://travis-ci.org/kiwix/kiwix-android.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-android) - Kiwix is an offline reader for Web content. One of its main purposes is to make Wikipedia available offline. This is done by reading the content of a file in the ZIM format, a high compressed open format with additional meta-data. +[![Build Status](https://travis-ci.org/kiwix/kiwix-android.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-android) +[![IRC Web](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](http://chat.kiwix.org) +--- + ## Build Instructions Production releases of the app should be built with our companion build repository [kiwix-build](https://github.com/kiwix/kiwix-build). @@ -14,15 +19,16 @@ We utilize different build variants (flavours) to build various different versio ## Libraries Used -- [Dagger](https://github.com/google/dagger) -- [Guava](https://github.com/google/guava) -- [SquiDb](https://github.com/yahoo/squidb) -- [Apache](https://github.com/apache/commons-io) -- [Retrofit](http://square.github.io/retrofit/) -- [OkHttp](https://github.com/square/okhttp) -- [Butterknife](http://jakewharton.github.io/butterknife/) -- [RxJava](https://github.com/ReactiveX/RxJava) -- [Mockito](https://github.com/mockito/mockito) +- [Dagger 2](https://github.com/google/dagger) - A fast dependency injector for Android and Java +- [SquiDb](https://github.com/yahoo/squidb) - SquiDB is a SQLite database library for Android and iOS +- [Retrofit](http://square.github.io/retrofit/) - Retrofit turns your REST API into a Java interface +- [OkHttp](https://github.com/square/okhttp) - An HTTP+SPDY client for Android and Java applications +- [Butterknife](http://jakewharton.github.io/butterknife/) - View "injection" library for Android +- [Mockito](https://github.com/mockito/mockito) - Most popular Mocking framework for unit tests written in Java +- [Guava](https://github.com/google/guava) - Collections, caching, primitives support, concurrency libraries, common annotations, string processing, I/O, and so forth. +- [Apache](https://github.com/apache/commons-io) - The Apache Commons IO library contains utility classes, stream implementations, file filters, file comparators, endian transformation classes, and much more. +- [RxJava](https://github.com/ReactiveX/RxJava) - Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM. + ## Contributing