Permalink
Browse files

readme

  • Loading branch information...
1 parent 9c7bf36 commit 49a830cf695102ddee1b41364e82d63b0f795b78 @jesperfj committed Nov 15, 2011
Showing with 24 additions and 2 deletions.
  1. +24 −2 README.md
View
@@ -1,4 +1,26 @@
-# Sample Force.com REST API application
+This project is a simple aggregator project that let's you quickly clone and build the force-rest-sample along with forks of maven-force-plugin and java-sdk.
-This is a simple example of how you can build Java apps that are [Force.com REST API](https://deveoper.force.com/rest) clients.
+## How to build
+clone this repository and check out submodules:
+
+ $ git clone --recursive https://github.com/jesperfj/force-rest-sample-aggregator.git
+
+If you want to run tests, you'll need to set up a test.properties file in the force-rest-api repo. Checkout the README in the repo for more detail.
+
+Build without running tests:
+
+ $ cd force-rest-sample-aggregator
+ $ mvn install -DskipTests
+
+## How to run
+
+Now set your Force.com username and password in environment variables:
+
+ $ export FORCE_USERNAME=john@doe.com
+ $ export FORCE_PASSWORD=secretpassword
+
+Now you can run the app from the `force-rest-jetty-sample` directory:
+
+ $ cd force-rest-jetty-sample
+ $ foreman start

0 comments on commit 49a830c

Please sign in to comment.