Spring/spring-data-gemfire
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SGF-300 - Update GitHub README page.

Browse Source
This commit is contained in:
John Blum
2017-05-08 18:46:49 -07:00
parent 87d5e7e16a
commit 331d3abec9
1 changed files with 50 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
README.md
View File

@@ -1,26 +1,31 @@
Spring Data GemFire
===================
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 GemFire](http://projects.spring.io/spring-data-gemfire) project
is to make it easier to build highly scalable, _Spring_ powered applications using [Pivotal GemFire](https://pivotal.io/pivotal-gemfire)
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 GemFire_, 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).
For more detailed questions, visit [_StackOverflow_](https://stackoverflow.com/questions/tagged/spring-data-gemfire).
If you are new to _Spring_ as well as _Spring Data GemFire_, look for information about
[_Spring_ projects](http://spring.io/projects).
Quick Start
-----------
For those in a hurry:
* Download the jar through
For developers in a hurry, you can download the JAR using:
* Maven:
@@ -29,32 +34,25 @@ For those in a hurry:
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-gemfire</artifactId>
<version>${version}</version>
</dependency>
</dependency>
<!-- used for nightly builds -->
<!-- nightly builds -->
<repository>
<id>spring-maven-snapshot</id>
<snapshots><enabled>true</enabled></snapshots>
<name>Springframework Maven SNAPSHOT Repository</name>
<name>Spring Maven SNAPSHOT Repository</name>
<url>http://repo.spring.io/snapshot</url>
</repository>
<!-- used for milestone/rc releases -->
<repository>
<id>spring-maven-milestone</id>
<name>Springframework Maven Milestone Repository</name>
<url>http://repo.spring.io/milestone</url>
<snapshots><enabled>true</enabled></snapshots>
</repository>
<!-- required for gemfire jar -->
<!-- milestones/release candidates-->
<repository>
<id>spring-maven-plugins-release</id>
<name>Springframework Maven Plugins Release Repository</name>
<url>http://repo.spring.io/plugins-release</url>
</repository>
<id>spring-maven-milestone</id>
<name>Spring Maven Milestone Repository</name>
<url>http://repo.spring.io/milestone</url>
</repository>
~~~~~
* Gradle:
* Gradle:
~~~~~ groovy
repositories {
@@ -64,39 +62,35 @@ 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 GemFire cache and Region (REPLICATE, PARTITION and so on):
~~~~~ xml
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:gfe="http://www.springframework.org/schema/gemfire"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/gemfire http://www.springframework.org/schema/gemfire/spring-gemfire.xsd">
<gfe:cache />
<gfe:partitioned-region id="partition" copies="2" total-buckets="4">
<gfe:cache/>
<bean id="gemfireTemplate" class="org.springframework.data.gemfire.GemfireTemplate" p:region-ref="someRegion"/>
<gfe:partitioned-region id="ExampleRegion" copies="2">
<bean id="gemfireTemplate" class="org.springframework.data.gemfire.GemfireTemplate" p:region-ref="ExampleRegion"/>
</beans>
~~~~~
* Use the Region to read/write data:
~~~~~ java
region.put(Long.valueOf(1), new Person("Jane", "Smith"));
region.put(Long.valueOf(1), new Person("Jon", "Doe"));
~~~~~
* Or/And `GemFireTemplate` to interact with GemFire:
* And/Or `GemFireTemplate` to interact with GemFire:
~~~~~ java
template.query("person = 1");
@@ -104,28 +98,28 @@ 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 GemFire_ uses Maven as its build system. To compile the project, simply type the following Maven command
from the root folder:
gradlew
To generate IDE-specific files, use
gradlew eclipse
or
gradlew idea
depending on your editor.
mvn clean install
# Contributing
Here are some ways for you to get involved in the community:
* Get involved with the Spring community on the Spring Community Forums (now on StackOverflow). Please help out on the [forum](https://stackoverflow.com/questions/tagged/spring-data-gemfire) by responding to questions and joining the debate.
* Create [JIRA](https://jira.spring.io/browse/SGF) tickets for bugs and new features and comment and vote on the ones that you are interested in.
* GitHub is for social coding. If you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
* Watch for upcoming articles on Spring by [subscribing](http://spring.io/blog) to spring.io.
* Get involved with the _Spring_ community on the _Spring_ Community Forums (_StackOverflow_).
Please help out on the [forum](https://stackoverflow.com/questions/tagged/spring-data-gemfire)
by responding to questions and joining the debate.
* Create [JIRA](https://jira.spring.io/browse/SGF) tickets for bugs and new features and comment and vote on the bugs
you are interested in.
* GitHub is for social coding. If you want to write code, we encourage contributions through pull requests
from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way,
please reference a JIRA ticket as well covering the specific issue you are addressing.
* Watch for upcoming articles on _Spring_ by [subscribing](http://spring.io/blog) to spring.io.
Before we accept a non-trivial patch or pull request we will need you to [sign the Contributor License Agreement](https://cla.pivotal.io/sign/spring). Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
Before we accept a non-trivial patch or pull request we will need you to
[sign the Contributor License Agreement](https://cla.pivotal.io/sign/spring). Signing the contributor’s agreement
does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions,
and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request.
Active contributors might be asked to join the core team, and given the ability to merge pull requests.