Skip to content

Commit

Permalink
README.md: some first updates for V3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
greenrobot committed Jul 5, 2016
1 parent 02bdbe6 commit b7c6e1a
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
greenDAO
========
greenDAO is a light & fast ORM solution for Android that maps objects to SQLite databases. Being highly optimized for Android, greenDAO offers great performance and consumes minimal memory.
greenDAO is a light & fast ORM for Android that maps objects to SQLite databases. Being highly optimized for Android, greenDAO offers great performance and consumes minimal memory.

**<font size="+1">Home page, documentation, and support links: http://greenrobot.org/greendao/</font>**

Expand All @@ -12,27 +12,25 @@ greenDAO's unique set of features:

* Rock solid: greenDAO has been around since 2011 and is used by countless famous apps
* Super simple: concise and straight-forward API
* Small: The library is <100K and it's just plain Java jar (no CPU dependent native parts)
* Small: The library is <150K and it's just plain Java jar (no CPU dependent native parts)
* Fast: Probably the fastest ORM for Android, driven by intelligent code generation
* Safe and expressive query API: QueryBuilder uses property constants to avoid typos
* Powerful joins: query across entities and even chain joins for complex relations
* Flexible property types: use custom classes or enums to represent data in your entity


Add greenDAO to your project
----------------------------
greenDAO is available on Maven Central. Please ensure that you are using the latest versions by [checking here](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.greenrobot%22%20AND%20a%3A%22greendao%22) [and here](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.greenrobot%22%20AND%20a%3A%22greendao-generator%22)

Gradle dependency for your Android app:
```
compile 'org.greenrobot:greendao-encryption:2.2.2'
compile 'org.greenrobot:greendao:3.0.0'
```

Gradle dependency for your Java generator project:
```
compile 'org.greenrobot:greendao-generator:2.2.0'
compile 'org.greenrobot:greendao-generator:3.0.0'
```
*Note:* to use encrypted databases using SQLCipher, you need to reference different artifacts (postfix '-encryption'). For all details, please refer to the documentation on [database encryption](http://greenrobot.org/greendao/documentation/database-encryption/).

Homepage, Documentation, Links
------------------------------
Expand All @@ -48,17 +46,6 @@ For more details on greenDAO please check [greenDAO's website](http://greenrobot

[Non-Technical FAQ](http://greenrobot.org/greendao/documentation/faq/)

Features in Beta
----------------
Those features are already here for you to try out. Note: Documentation and test coverage may be lacking, and the API may change in the future.
### Asynchronous API
* New AsyncSession (acquired from DaoSession.startAsyncSession()) provides most operations for DAOs, Queries, and transactions in a asynchronously variant
* AsyncOperations are processed in order by a background thread
* waitForCompletion methods for AsyncSession and AsyncOperations
* AsyncOperationListener for asynchronous callback when operations complete
* Asynchronous operations can be merged in single transactions (details follow)
* Added raw SQL queries returning a Query object (LazyList support etc.)

More Open Source by greenrobot
==============================
[__EventBus__](https://github.com/greenrobot/EventBus) is a central publish/subscribe bus for Android with optional delivery threads, priorities, and sticky events. A great tool to decouple components (e.g. Activities, Fragments, logic components) from each other.
Expand Down

0 comments on commit b7c6e1a

Please sign in to comment.