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.

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

Improve Readme #20

Open
ans-4175 opened this issue Nov 12, 2021 · 1 comment
Open

Improve Readme #20

ans-4175 opened this issue Nov 12, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ans-4175
Copy link
Owner

Add meaningful Readme for:

  • Basic Motivation
  • Algorithm Explanation
  • Contributor Section and Contact

Erm, what else?

@ans-4175 ans-4175 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 12, 2021
@ans-4175 ans-4175 self-assigned this Nov 12, 2021
@imballinst
Copy link
Collaborator

Hmm, perhaps these?

  1. Available features: list of currently implemented features (e.g. randomize password by letters/kata + pelafalan, copy to clipboard). A screenshot can also be useful.
  2. Link to the app: since the link to the app is only available above and not if we scroll, perhaps we can also add the link to the app as well in the README.md?

image

image

  1. Not sure, but does Vercel have this "deploy badge" or something? We can show the current deployed app status for fanciness purposes, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants