Added build instructions to README.

This commit is contained in:
2012-04-28 17:44:52 -04:00
parent 2e5301c38c
commit 7511c15d6e

View File

@@ -9,6 +9,36 @@ The Zappos API has reasonably complete documentation at
will need an API key (available for free upon request from
Zappos).
# Building
Dependency resolution and the project build are managed with
[Maven](http://maven.apache.org/).
## Tests
Builds will automatically run tests that require a Zappos API
key. If you wish to run these tests yourself:
1. Copy the file `src/test/resources/apikey.properties.template` to `src/test/resources/apikey.properties`
2. Fill in your API key on the appropriate line in `apikey.properties`
If you would like to disable these tests, add the argument
`-Dskiptests` to all invocations of `mvn`.
## Installing locally
Run `mvn install` to install the library to your local Maven
repository. Any other projects managed with Maven will be able
to find it.
## Building a standalone jar
If you don't manage your dependencies with Maven, you can still
build a stand-alone jar. Running `mvn package` will build jars
in `target/`. You can add the `-jar-with-dependencies.jar` file
that is built to your project's classpath, and you should be
able to use Zappy from there.
# Using the library
There is a class for each of the supported API search predicates: