ashtuchkin / u2f

U2F Authentication for Node.js
399 stars 47 forks source link

Clarify registration/authentication instructions in README #6

Closed LINKIWI closed 7 years ago

LINKIWI commented 7 years ago

Hi, thanks for creating this module! I've used it to implement U2F authentication in one of my personal projects but had some trouble understanding the code examples in the README instructions to get everything working on both the server and client.

This PR clarifies the U2F registration/authentication instructions in the README, especially clarifying points of confusion I encountered as someone who is not familiar with the official U2F API spec.

I have also fixed an error on the client-side documentation. Namely, the existing u2f client calls are inconsistent with what the official FIDO client-side API spec specifies as input to window.u2f.register and window.u2f.sign.

ashtuchkin commented 7 years ago

Looks great, thank you!