Skip to content

Commit

Permalink
Merge pull request #10 from yahoo/updateReadme
Browse files Browse the repository at this point in the history
Added instructions on adding elide to pom.xml.
  • Loading branch information
Dennis McWherter committed Oct 19, 2015
2 parents 5721139 + 1158a03 commit cf4180d
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@

#Elide

## Using Elide

To integrate Elide into your project, simply include elide-core into your project's pom.xml:

```xml
<!-- Elide -->
<dependency>
<groupId>com.yahoo.elide</groupId>
<artifactId>elide-core</artifactId>
<version>1.0.0.1</version>
</dependency>
```

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
<dependency>
<groupId>com.yahoo.elide</groupId>
<artifactId>elide-dbmanager-inmemorydb</artifactId>
<version>1.0.0.1</version>
</dependency>
```

##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.
Expand Down

0 comments on commit cf4180d

Please sign in to comment.