From a6b2719c0df4cef821ed141f6fcdb7741026ee8c Mon Sep 17 00:00:00 2001 From: Filip Hanik Date: Tue, 15 Jan 2019 09:59:02 -0800 Subject: [PATCH] Update README --- .editorconfig | 2 +- README.md | 21 ++++++++++++++++++++- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index 160e90ba7..fa690f064 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,5 +1,5 @@ # EditorConfig for Spring Security -# see https://github.com/spring-projects/spring-security-saml/blob/master/CONTRIBUTING.md#mind-the-whitespace +# see https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.md#mind-the-whitespace root = true diff --git a/README.md b/README.md index c1df336fa..9cd613d28 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,29 @@ [![Build Status](https://travis-ci.org/spring-projects/spring-security-saml.svg?branch=develop)](https://github.com/spring-projects/spring-security-saml/) +## Upgrade note + +This project is being rewritten. There is a base implementation in the +[develop](https://github.com/spring-projects/spring-security-saml/tree/develop) including +milestone releases in the [milestone](https://repo.spring.io/milestone/org/springframework/security/extensions/spring-security-saml2-core/) +repository. + +In the [develop-3.0](https://github.com/spring-projects/spring-security-saml/tree/develop) branch we are creating a +solution that builds on top of the milestones and is better aligned with Spring Security. +The intent with this branch is to merge it with the [Spring Security](https://github.com/spring-projects/spring-security) +project and release as part of Spring Security core. + +For that reason, we will not be publishing any official releases of the 2.0.0 milestones, but will maintain it +until all feature functionality that exists in the milestones are part of Spring Security. + +We continue to accept pull request for the 1.0.x branch, but are not actively developing it. + +## Introduction + Spring SAML Extension allows seamless inclusion of SAML 2.0 Service Provider capabilities in Spring applications. All products supporting SAML 2.0 in Identity Provider mode (e.g. ADFS 2.0, Shibboleth, OpenAM/OpenSSO, Ping Federate, Okta) can be used to connect with Spring SAML Extension. ## Code of Conduct -This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.adoc). +This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. ## Links