README improvements - Githubissues

supertokens / supertokens-website

Frontend SDK for SuperTokens - for session management + automatically refreshing sessions

https://supertokens.com

Other

54 stars 13 forks source link

README improvements #114

Open makeitcount opened 2 years ago

makeitcount commented 2 years ago

The current readme does not give a good overview of the project and does not guide the reader properly to use it. Some changes, that will fix it

[ ] Screenshots of what user will be able to build with this library
[x] Installation code snippets
[x] Usage code snippets
[ ] Visuals to show how frontend connect with the auth backend
[ ] Link to demo
[x] Supertokens architecture/flow diagram
[ ] Better contextual links to docs/resources

rishabhpoddar commented 2 years ago

Sounds good. Please feel free to make a PR for these. Also, there are no visuals provided by this library + there is no demo that uses just this library. Other than that, the points are good.