diff --git a/README.md b/README.md index cae656db99..786e43fa22 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ #Elide +## Using Elide + +To integrate Elide into your project, simply include elide-core into your project's pom.xml: + +```xml + + + com.yahoo.elide + elide-core + 1.0.0.1 + +``` + +Additionally, if you do not plan to write your own database manager, select the appropriate DB manager for your setup and include it as well. For instance, if you plan on using the "in-memory database" (not recommended for production use) then you would add the following: + +```xml + + com.yahoo.elide + elide-dbmanager-inmemorydb + 1.0.0.1 + +``` + ##What Is Elide? Elide is a Java library that let's you stand up a [JSON API](http://jsonapi.org) web service with minimal effort starting from a JPA annotated data model.