Skip to content

Commit 05c82d9

Browse files
committed
Update readme.md for 1.0.0 release
1 parent 3fe419e commit 05c82d9

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@
33

44
## Updating from 0.9.x to 1.0.X
55

6-
Version `1.0` is a recommended update for all Ruby SAML users since include security fixes.
7-
Adds security improvements like entity expansion limitation, more saml message validations and other important improvements like decrypt support. For more details, please review [the changelog](changelog.md). Also notice that in this version the get_idp_metadata method raise an exception when not able to fetch the idp metadata, so review your integration if you are using this functionality.
6+
Version `1.0` is a recommended update for all Ruby SAML users as it includes security fixes.
7+
8+
Version `1.0` adds security improvements like entity expansion limitation, more SAML message validations, and other important improvements like decrypt support.
9+
10+
For more details, please review [the changelog](changelog.md).
11+
12+
### Important Changes
13+
Please note the `get_idp_metadata` method raises an exception when it is not able to fetch the idp metadata, so review your integration if you are using this functionality.
814

915
## Updating from 0.8.x to 0.9.x
1016
Version `0.9` adds many new features and improvements.
@@ -24,7 +30,7 @@ We created a demo project for Rails4 that uses the latest version of this librar
2430
* 1.8.7
2531
* 1.9.x
2632
* 2.1.x
27-
* 2.2.0
33+
* 2.2.x
2834

2935
## Adding Features, Pull Requests
3036
* Fork the repository
@@ -41,7 +47,7 @@ Using `Gemfile`
4147

4248
```ruby
4349
# latest stable
44-
gem 'ruby-saml', '~> 0.9'
50+
gem 'ruby-saml', '~> 1.0.0'
4551

4652
# or track master for bleeding-edge
4753
gem 'ruby-saml', :github => 'onelogin/ruby-saml'
@@ -123,7 +129,7 @@ end
123129
124130
In the above there are a few assumptions in place, one being that the response.nameid is an email address. This is all handled with how you specify the settings that are in play via the saml_settings method. That could be implemented along the lines of this:
125131
126-
If the assertion of the SAMLResponse is not encrypted, you can initialize the Response without the :settings parameter and set it later,
132+
If the assertion of the SAMLResponse is not encrypted, you can initialize the Response without the :settings parameter and set it later,
127133
128134
```
129135
response = OneLogin::RubySaml::Response.new(params[:SAMLResponse])

0 commit comments

Comments
 (0)