search

amazon-archives / amazon-cognito-auth-js

The Amazon Cognito Auth SDK for JavaScript simplifies adding sign-up, sign-in with user profile functionality to web apps.
Apache License 2.0
424 stars 232 forks source link

Rename SAMPLEREADME.md to README.md #105

Closed RickvdP closed 6 years ago

RickvdP commented 6 years ago

Renaming the file to README.md makes Github automatically parse and display it when opening the /sample directory (e.g. see my fork as example).

yuntuowang commented 6 years ago

Hi @RickvdP, we prefer to leave the name as SAMPLEREADME.md for the sample. In this way, it is not confusing because we already have README.md for the SDK library.