novoda/typewriter — pull request #11 by xrigau (2014-11-17 11:20:18+00:00)
Title: Adds a bit more info to the README

I haven't added a Simple usage section because this library needs documentation atm. I created issues #10 and #9 to address that.

### Preview

---

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

Minimal ORM for Android.

## Description

A dead simple ORM on top of Cursor and ContentProvider.

## 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:typewriter:0.0.3'
}
```

## 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/typewriter/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/typewriter/wiki)
* Looking for community help, browse the already asked [Stack Overflow Questions](http://stackoverflow.com/questions/tagged/support-typewriter) or use the tag: `support-typewriter` when posting a new question