From efd19162080c564d720aaa979315068f2570d513 Mon Sep 17 00:00:00 2001 From: John Blum Date: Thu, 13 Apr 2017 13:09:23 -0700 Subject: [PATCH] SGF-611 - Update README.MD. --- README.md | 83 ++++++++++++++++++++++--------------------------------- 1 file changed, 33 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 099dba9a..f96c693f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,23 @@ -Spring Data GemFire -=================== +Spring Data Geode +================= -The primary goal of the [Spring Data GemFire](http://http://projects.spring.io/spring-data-gemfire) project is to make it easier to build highly scalable, Spring-powered applications using -[Pivotal GemFire](http://www.pivotal.io/big-data/pivotal-gemfire) as a distributed, data management platform. +The primary goal of the [Spring Data Geode](http://projects.spring.io/spring-data-gemfire) project is to +make it easier to build highly scalable, _Spring_ powered applications using [Apache Geode](http://geode.apache.org/) +as the underlying distributed, in-memory data management platform. # Examples -For examples on using the Spring Data GemFire, see the [spring-gemfire-examples](https://github.com/SpringSource/spring-gemfire-examples) project. +For examples on using the _Spring Data Geode_, see the [spring-gemfire-examples](https://github.com/SpringSource/spring-gemfire-examples) project. # Getting Help -Read the main project [website](http://projects.spring.io/spring-data-gemfire/) and the [User Guide](http://docs.spring.io/spring-data-gemfire/docs/current/reference/html/). +Read the main project [website](http://projects.spring.io/spring-data-gemfire/) along with the [User Guide](http://docs.spring.io/spring-data-gemfire/docs/current/reference/html/). + Look at the source code and the [JavaDocs](http://docs.spring.io/spring-data-gemfire/docs/current/api/). + For more detailed questions, visit [StackOverflow](https://stackoverflow.com/questions/tagged/spring-data-gemfire). -If you are new to Spring as well as to Spring Data GemFire, look for information about [Spring projects](http://spring.io/projects). + +If you are new to _Spring_ as well as _Spring Data Geode_, look for information about [Spring projects](http://spring.io/projects). Quick Start ----------- @@ -27,34 +31,27 @@ For those in a hurry: ~~~~~ xml org.springframework.data - spring-data-gemfire + spring-data-geode ${version} - + - + spring-maven-snapshot - true - Springframework Maven SNAPSHOT Repository + Spring Maven SNAPSHOT Repository http://repo.spring.io/snapshot - - - - - spring-maven-milestone - Springframework Maven Milestone Repository - http://repo.spring.io/milestone + true - + - spring-maven-plugins-release - Springframework Maven Plugins Release Repository - http://repo.spring.io/plugins-release - + spring-maven-milestone + Spring Maven Milestone Repository + http://repo.spring.io/milestone + ~~~~~ -* Gradle: +* Gradle: ~~~~~ groovy repositories { @@ -64,29 +61,25 @@ repositories { } dependencies { - compile "org.springframework.data:spring-data-gemfire:${version}" + compile "org.springframework.data:spring-data-geode:${version}" } ~~~~~ -Latest GA release is _1.4.4.RELEASE_ -Latest nightly build is _1.5.0.BUILD-SNAPSHOT_ - - -* Configure a GemFire cache and Region (replicated, partitioned, client and so on): +* Configure a Geode cache and Region (REPLICATE, PARTITION and so on): ~~~~~ xml + http://www.springframework.org/schema/geode http://www.springframework.org/schema/gemfire/spring-geode.xsd"> - - - + - + + + ~~~~~ @@ -96,7 +89,7 @@ Latest nightly build is _1.5.0.BUILD-SNAPSHOT_ region.put(Long.valueOf(1), new Person("Jane", "Smith")); ~~~~~ -* Or/And `GemFireTemplate` to interact with GemFire: +* And/Or `GemFireTemplate` to interact with Geode: ~~~~~ java template.query("person = 1"); @@ -104,19 +97,9 @@ template.query("person = 1"); # Building -Spring GemFire uses Gradle as its building system. To compile the project, simply type from the root folder +_Spring Data Geode_ uses Maven as its build system. To compile the project, simply type from the root folder - gradlew - -To generate IDE-specific files, use - - gradlew eclipse - -or - - gradlew idea - -depending on your editor. + mvn clean install # Contributing