Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added instructions on adding elide to pom.xml. #10

Merged
merged 1 commit into from
Oct 19, 2015
Merged

Added instructions on adding elide to pom.xml. #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
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