Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mesosfer committed Oct 27, 2016
1 parent a2af58e commit c676da7
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Mesosfer Starter Project for Android #


A library that gives you access to the powerful Mesosfer cloud platform from your Android app.
For more information about Mesosfer and its features, see [Mesosfer Website][mesosfer.com] and [Mesosfer Documentations][docs].

## Release Changelog
* `0.1.0` (Oct 27, 2016)
- Initial release

## License
Copyright (c) 2016, Mesosfer.
All rights reserved.

This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree.

[mesosfer.com]:https://mesosfer.com
[docs]:https://docs.mesosfer.com/
[cloud]:https://cloud.mesosfer.com/
[library]:Library/MesosferSDK-Android-0.1.0.aar
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Mesosfer Starter Project for Android #


A library that gives you access to the powerful Mesosfer cloud platform from your Android app.
For more information about Mesosfer and its features, see [Mesosfer Website][mesosfer.com] and [Mesosfer Documentations][docs].

## Download
1. Download [the latest AAR][library] and copy it on `libs` directory.
2. Define in your `app` module `build.gradle` this code below before `dependencies`

```groovy
repositories{
flatDir {
dirs 'libs'
}
}
```

Then add this code below on `dependencies` :

```groovy
compile 'com.eyro.mesosfer:MesosferSDK-Android:0.1.0@aar'
```

## Setup
1. Register first to [Mesosfer Cloud][cloud]
2. Create an application to get `applicationId` and `clientKey`
3. Add this line below to your `Application` class to initialize Mesosfer SDK

```java
Mesosfer.initialize(this, "YOUR-APPLICATION-ID-HERE", "YOUR-CLIENT-KEY-HERE");
```
Don't forget to initialize your application class to `AndroidManifest.xml`

(Optional) You can add some custom setup :

* Enable Mesosfer Push Notification by calling `Mesosfer.setPushNotification(boolean)`
* Enable Mesosfer SDK debug logging by calling `Mesosfer.setLogLevel(int);` before initialize SDK.
* Mesosfer Log Level Mode : `LOG_LEVEL_VERBOSE`, `LOG_LEVEL_DEBUG`, `LOG_LEVEL_INFO`, `LOG_LEVEL_WARNING`, `LOG_LEVEL_ERROR`, `LOG_LEVEL_NONE`

Everything is done!

## License
Copyright (c) 2016, Mesosfer.
All rights reserved.

This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree.

[mesosfer.com]:https://mesosfer.com
[docs]:https://docs.mesosfer.com/
[cloud]:https://cloud.mesosfer.com/
[library]:Library/MesosferSDK-Android-0.1.0.aar

0 comments on commit c676da7

Please # to comment.