jupyterhub / jupyterhub/nativeauthenticator

Update README - Images, feature highlights, hmmm?

Open
#166 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
81
Forks
68
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.