search

mkhorasani / Streamlit-Authenticator

A secure authentication module to validate user credentials in a Streamlit application.
Apache License 2.0
1.38k stars 229 forks source link

Clean up README.md #51

Closed fascani closed 1 year ago

fascani commented 1 year ago

Some possible corrections:

  1. Say somewhere one needs to install pyyaml and import yaml
  2. In the first code snippet in 'Creating a login widget', replace Loader=SafeLoader by Loader=yaml.SafeLoader

Or something like that as I struggled to realize the above from the README.md. It may be obvious to a lot of folks but it was not to me.

I could do it myself but I am hesitant as I don't want to interfere in your README. Package is great by the way! Thanks!

mkhorasani commented 1 year ago

Hey @fascani, that's an excellent point, I have modified section 2 in the readme file to reflect this. Cheers!