Repository: usergrid Updated Branches: refs/heads/master ab6df5353 -> dad3aba38
Minor README corrections. Project: http://git-wip-us.apache.org/repos/asf/usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/usergrid/commit/dad3aba3 Tree: http://git-wip-us.apache.org/repos/asf/usergrid/tree/dad3aba3 Diff: http://git-wip-us.apache.org/repos/asf/usergrid/diff/dad3aba3 Branch: refs/heads/master Commit: dad3aba38caad722f40b9d00616e140bd9124752 Parents: ab6df53 Author: Dave Johnson <snoopd...@apache.org> Authored: Wed Feb 10 16:37:37 2016 -0500 Committer: Dave Johnson <snoopd...@apache.org> Committed: Wed Feb 10 16:37:37 2016 -0500 ---------------------------------------------------------------------- README.md | 8 +++----- stack/README.md | 7 ++++++- 2 files changed, 9 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/usergrid/blob/dad3aba3/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 7dde68a..ca63047 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,16 @@ Apache Usergrid Overview -------- -**Apache Usergrid is a multi-tenant Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs.** +**Usergrid is a multi-tenant Backend-as-a-Service stack for web & mobile apps, based on RESTful APIs.** ## Contributing -We accept all contributions via our GitHub, so you can fork our repo (apache/usergrid) and then submit a PR back to us for approval. For larger PRs you'll need to have an ICLA form on file with Apache. For more information see our [Contribution Workflow Policy](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Contribution+Workflow), and specifically our [External Contributors Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+External+Contributors+Guide). +We accept all contributions via our GitHub, so you can fork our repo (apache/usergrid) and then submit a PR back to us for approval. For larger PRs you'll need to have an ICLA form on file with Apache. For more information see [How to Contribute Code & Docs](http://usergrid.apache.org/docs/reference/contribute-code.html). ## Build awesome apps with Usergrid! Apache Usergrid provides all code necessary to build and power modern mobile applications. This includes the server stack, administrative portal website, SDKs in most popular languages, as well as command line tools. -Look for much more detailed README files in their corresponding subdirectories, or check out [our website](http://usergrid.apache.org/) for more info. - * The server-side stack, a Java 8 + Cassandra + ElasticSearch codebase that powers all of the features, is located under [`/stack`](stack). You can install dependencies and compile it with maven. See [stack/README.md](stack#requirements) for instructions. * The admin portal is a pure HTML5+JavaScript app allowing you to register developers and let them manage their apps in a multi-tenant cluster. Located under [`/portal`](portal) @@ -26,5 +24,5 @@ Look for much more detailed README files in their corresponding subdirectories, ## For more information -See the [Apache Usergrid web site](http://usergrid.apache.org/). +See the Apache Usergrid [web site](http://usergrid.apache.org) and [documentation](http://usergrid.apache.org). http://git-wip-us.apache.org/repos/asf/usergrid/blob/dad3aba3/stack/README.md ---------------------------------------------------------------------- diff --git a/stack/README.md b/stack/README.md index 407b9e5..c9fbf7e 100644 --- a/stack/README.md +++ b/stack/README.md @@ -20,6 +20,11 @@ From the command line, go to the usergrid directory and type the following: mvn clean install -DskipTests=true +If you want to run tests you will need to have Cassandra and ElasticSearch running on your computer and on the default ports. The following command will do the build and run all JUnit tests: + + mvn clean install + + ## Running The build process will package the Usergrid Stack into one file `stack/rest/target/ROOT.war` @@ -73,7 +78,7 @@ Letâs use it to create a collection with some data in it: ## Contributing -We welcome all contributions, including via pull requests on GitHub! If you want to submit code, please read more about our [contribution workflow](https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow) +We welcome all contributions, including via pull requests on GitHub! For more information see [How to Contribute Code & Docs](http://usergrid.apache.org/docs/reference/contribute-code.html). ## Licenses
