novoda/merlin — pull request #50 by xrigau (2014-11-14 13:57:07+00:00)
Title: USes the new structure for the README file

### Peview

----

# TITLE [![](http://ci.novoda.com/buildStatus/icon?job=merlin)](http://ci.novoda.com/job/merlin/lastSuccessfulBuild/console) [![](https://raw.githubusercontent.com/novoda/novoda/master/assets/btn_apache_lisence.png)](LICENSE.txt)

An Ok name for a library.

## Description

Merlin aims to simplify network monitoring by providing 3 registerable callbacks.
`onConnect()` , `onDisconnect()` and `onBind(NetworkStatus networkStatus)`.

## Adding to your project

To start using this library, add these lines to the `build.gradle` of your project:

```groovy
repositories {
jcenter()
}

dependencies {
compile 'com.novoda:merlin:0.6.1'
}
```

## Simple usage

Create Merlin:

```java
merlin = new Merlin.Builder().withConnectableCallbacks().build(context);
```

Bind and unbind the service in your activity:

```java
@Override
protected void onResume() {
super.onResume();
merlin.bind();
}

@Override
protected void onPause() {
merlin.unbind();
super.onPause();
}
```

Register for callbacks:

```java
merlin.registerConnectable(new Connectable() {
@Override
public void onConnect() {
// Do something!
}
});
```

Also check the [wiki](https://github.com/novoda/merlin/wiki/Usecases-and-API-usage#retrieve-current-network-state) to see how you can use `MerlinsBeard` to check the network state.

## Links

Here are a list of useful links:

* We always welcome people to contribute new features or bug fixes, [here is how](https://github.com/novoda/novoda/blob/master/CONTRIBUTING.md)
* If you have a problem check the [Issues Page](https://github.com/novoda/merlin/issues) first to see if we are working on it
* For further usage or to delve more deeply checkout the [Project Wiki](https://github.com/novoda/merlin/wiki)
* Looking for community help, browse the already asked [Stack Overflow Questions](http://stackoverflow.com/questions/tagged/support-merlin) or use the tag: `support-merlin` when posting a new question