AeroGear Project Info Template

README.md

AeroGear Android Core

AeroGear's Android libraries were built as jar, apklib and aar using Maven and the android-maven-plugin. The project follows the standard Android project layout as opposed to the standard Maven layout so sources will be in /src instead of /src/main/java and can be imported directly into IDE as an Android project.

Core

The core library contains common components and interfaces which the rest of the AeroGear Android libraries depend on.

	Project Info
License:	Apache License, Version 2.0
Build:	Maven
Documentation:	http://aerogear.org/docs/guides/aerogear-android/
Issue tracker:	https://issues.jboss.org/browse/AGDROID
Mailing lists:	aerogear-users (subscribe)
	aerogear-dev (subscribe)

Building

Until the 2.0 modules are stable and in Maven Central, we will need to build the projects first. Please take a look of the step by step on our website

Usage

There are two supported ways of developing apps using AeroGear for Android: Android Studio and Maven.

Android Studio

Add to your application's build.gradle file

dependencies {
  compile 'org.jboss.aerogear:aerogear-android-core:2.0.0'
  //My other dependencies
}

And in your project's build.gradle files you will need to add:

allprojects {
    repositories {
	mavenLocal();
        //All other repositories
    }
}

Maven

Include the following dependencies in your project's pom.xml

<dependency>
  <groupId>org.jboss.aerogear</groupId>
  <artifactId>aerogear-android-core</artifactId>
  <version>2.0.0</version>
  <scope>provided</scope>
  <type>jar</type>
</dependency>

<dependency>
  <groupId>org.jboss.aerogear</groupId>
  <artifactId>aerogear-android-core</artifactId>
  <version>2.0.0</version>
  <type>apklib</type>
</dependency>

Documentation

For more details about the current release, please consult our documentation.

Development

If you would like to help develop AeroGear you can join our developer's mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Also takes some time and skim the contributor guide

Questions?

Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!

Found a bug?

If you found a bug please create a ticket for us on Jira with some steps to reproduce it.

First impression: this looks slick and solid!

pointing to doc (on site) is very important - and this clearly addresses DEVs - and "users" can navigate to the doc, for getting started.

Once "all the (GH) things" have been updated, I will disable the GH issues