-
-
Notifications
You must be signed in to change notification settings - Fork 252
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
docs: improve readme #418
docs: improve readme #418
Conversation
✅ Deploy Preview for robyn canceled.
|
c36610d
to
3bd8c91
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks great! But, would this not replace the README preview on the main GitHub preview?
3bd8c91
to
662f251
Compare
The |
We can do that but what will be different in both of them? |
c80ba80
to
f4cb518
Compare
I updated the |
f4cb518
to
a047076
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work @AntoineRR . LGTM! 👍
Description
This is a proposal for a new readme with updated information.
Also the readme was duplicated in the
docs
folder. I kept only the one in thedocs
folder as it should appear on the repo homepage too as stated in this documentation. This will make us maintain only one readme instead of trying to keep both in sync.