Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README improvements #114

Open
3 of 7 tasks
makeitcount opened this issue Mar 28, 2022 · 1 comment
Open
3 of 7 tasks

README improvements #114

makeitcount opened this issue Mar 28, 2022 · 1 comment

Comments

@makeitcount
Copy link
Contributor

makeitcount commented Mar 28, 2022 •
edited
Loading

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
  • Installation code snippets
  • Usage code snippets
  • Visuals to show how frontend connect with the auth backend
  • Link to demo
  • Supertokens architecture/flow diagram
  • Better contextual links to docs/resources
@rishabhpoddar
Copy link
Contributor

rishabhpoddar commented Mar 28, 2022 •
edited
Loading

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.

@makeitcount makeitcount mentioned this issue Mar 28, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rishabhpoddar @makeitcount