Skip to content

Commit 74d53e8

Browse files
committed
Add additional information to README
1 parent 77deb63 commit 74d53e8

File tree

2 files changed

+42
-9
lines changed

2 files changed

+42
-9
lines changed

CONTRIBUTING.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ something, or simply want to hack on the code this document should help you get
66

77
== Code of Conduct
88

9-
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct]
9+
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct].
1010

1111

1212
== Reporting Security Vulnerabilities
@@ -26,7 +26,6 @@ information as possible. Ideally, that would include a small sample project that
2626
reproduces the problem.
2727

2828

29-
3029
== Sign the Contributor License Agreement
3130
If you have not previously done so, please fill out and
3231
submit the https://cla.pivotal.io/sign/spring[Contributor License Agreement].

README.adoc

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,61 @@ It also provides transparent integration with:
1313
1414
== Modules
1515

16-
Spring Session consists of the following modules:
16+
This Spring Session repository consists of the following modules:
1717

1818
* Spring Session Core - provides core Spring Session functionalities and APIs
1919
* Spring Session Data Redis - provides `SessionRepository` and `ReactiveSessionRepository` implementation backed by Redis and configuration support
2020
* Spring Session JDBC - provides `SessionRepository` implementation backed by a relational database and configuration support
2121
* Spring Session Hazelcast - provides `SessionRepository` implementation backed by Hazelcast and configuration support
2222

23+
Additional Spring Session modules can be found in the https://github.com/spring-projects/spring-session-data-mongodb[spring-session-data-mongodb] repository
24+
and [https://github.com/spring-projects/spring-session-data-geode]spring-session-data-geode repository.
2325

24-
== Code of Conduct
26+
== Getting Started
27+
28+
We recommend you visit the https://docs.spring.io/spring-session/docs/current/reference/html5/#samples[Spring Session Reference] and look through the "Samples and Guides" section to see which one best suits your needs.
29+
30+
== Samples
31+
32+
Spring Session samples are available in the https://github.com/spring-projects/spring-session/tree/master/spring-session-samples[spring-session-samples] directory.
33+
34+
35+
== Contributing
2536

26-
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct]
37+
Please see our https://github.com/spring-projects/spring-session/blob/master/CONTRIBUTING.adoc[Contributing guidelines]
38+
for information on how to report issues, enhancements or security vulnerabilities.
2739

40+
== Building from Source
2841

29-
== Reporting Security Vulnerabilities
42+
Spring Session uses a https://gradle.org[Gradle]-based build system.
43+
In the instructions below, `./gradlew` is invoked from the root of the source tree and serves as
44+
a cross-platform, self-contained bootstrap mechanism for the build.
3045

31-
Please see our https://github.com/spring-projects/spring-session/security/policy[Security policy].
46+
Check out sources
47+
----
48+
git clone [email protected]:spring-projects/spring-session.git
49+
----
3250

51+
Install all spring-\* jars into your local Maven cache
52+
----
53+
./gradlew install
54+
----
3355

34-
== Spring Session Project Site
56+
Compile and test; build all jars, distribution zips, and docs
57+
----
58+
./gradlew build
59+
----
60+
61+
62+
== Documentation
63+
64+
You can find the documentation, samples, and guides for using Spring Session on the https://projects.spring.io/spring-session/[Spring Session project site].
65+
66+
For more in depth information, visit the https://docs.spring.io/spring-session/docs/current/reference/html5/[Spring Session Reference].
67+
68+
== Code of Conduct
3569

36-
You can find the documentation, issue management, support, samples, and guides for using Spring Session at https://projects.spring.io/spring-session/
70+
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct].
3771

3872
== License
3973

0 commit comments

Comments
 (0)