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

Update README - Images, feature highlights, hmmm? #166

Open
consideRatio opened this issue Oct 29, 2021 · 1 comment
Open

Update README - Images, feature highlights, hmmm? #166

consideRatio opened this issue Oct 29, 2021 · 1 comment

Comments

@consideRatio
Copy link
Member

I think we should avoid duplicating much content between the README.md file and the docs, but its probably worth trying to capture the readers attention in the README.md to make the user interested in reading more in the docs.

To do this, I think we could perhaps provide a selection of feature highlights, and then link out to the docs?

Currently we have a list of features that isn't updated to include the 2FA authentication, which to me, is one of the coolest features. But, adding it to the list of several features outlines feels like its not doing it justice, so I was thinking if we perhaps instead graphically highlight a few features, and then link out to docs to cover them all.

@lambdaTotoro
Copy link
Collaborator

This is a good idea. We can cover the main points in prose and maybe build a graphic or record one of your fancy GIFs for the README, then link to the docs for details.

@lambdaTotoro lambdaTotoro added this to the Version 1.1 milestone Oct 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants