Readme improvements #27
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
grzuy
approved these changes
May 25, 2018
README.md
Outdated
| @@ -5,6 +5,24 @@ Easily implement WebAuthn in your ruby web server | |||
| [](https://rubygems.org/gems/webauthn) | |||
| [](https://travis-ci.org/cedarcode/webauthn-ruby) | |||
|
|
|||
| ## WARNING: THIS IS AN EXPERIMENTAL GEM BASED ON A RECOMENDATION DRAFT AND CURRENTLY UNDER DEVELOPMENT. IT'S NOT ADVISED TO USE IT IN A PRODUCTION ENVIRONMENT. | |||
There was a problem hiding this comment.
I'd rather say "WARNING: This gem is in the early development phase. Use on production at your own risk."
README.md
Outdated
| - Mozilla Firefox Quantum 60+ (Enabled by default). | ||
| - Google Chrome 65+ (Disabled by default, go to chrome:https://flags to enable Web Authentication API feature). Note: it is enabled by default in 67+ as stated [here](https://www.chromestatus.com/feature/5669923372138496). | ||
|
|
||
| ## Authenticator devises compatibility |
README.md
Outdated
| @@ -51,13 +69,27 @@ attestation_response = WebAuthn::AuthenticatorAttestationResponse.new( | |||
| client_data_json: client_data_json | |||
| ) | |||
|
|
|||
| if attestation_response.valid?(original_challenge) | |||
| # This value needs to match `window.location.origin` evaludated by | |||
README.md
Outdated
|
|
||
| ## Authenticator devises compatibility | ||
|
|
||
| The user agents mentioned in the previous section, only support USB FIDO2 or FIDO U2F enabled devises in their current implementations. |
There was a problem hiding this comment.
Somehow make it more clear that we are talking about physical security keys like https://www.yubico.com/product/security-key-by-yubico/ ?
There was a problem hiding this comment.
Maybe add an example of what is a FIDO2 enabled device
README.md
Outdated
|
|
||
| ## Authenticator devises compatibility | ||
|
|
||
| The user agents mentioned in the previous section, only support USB FIDO2 or FIDO U2F enabled devises in their current implementations. |
README.md
Outdated
| @@ -5,6 +5,24 @@ Easily implement WebAuthn in your ruby web server | |||
| [](https://rubygems.org/gems/webauthn) | |||
| [](https://travis-ci.org/cedarcode/webauthn-ruby) | |||
|
|
|||
| ## WARNING: THIS IS AN EXPERIMENTAL GEM BASED ON A RECOMENDATION DRAFT AND CURRENTLY UNDER DEVELOPMENT. IT'S NOT ADVISED TO USE IT IN A PRODUCTION ENVIRONMENT. | |||
|
|
|||
| ## Useful documentation on WebAuthn | |||
There was a problem hiding this comment.
What about changing the title to "What is WebAuthn?"
README.md
Outdated
| - [Web Authentication API draft article by Mozilla](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API) | ||
| - [W3C Draft Recommendation](https://w3c.github.io/webauthn/) | ||
|
|
||
| ## User Agent compatibility |
There was a problem hiding this comment.
What about making "User agent compatibility" and "Authenticator devices compatibility" subsections of a section called "Prerequisites"?
| ### Validation phase | ||
|
|
||
| *Currently under development* | ||
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.