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

Reformat repo README #130

Merged
merged 2 commits into from
Jun 22, 2021
Merged

Reformat repo README #130

merged 2 commits into from
Jun 22, 2021

Conversation

osanseviero
Copy link
Member

This changes the main repo README to be more relevant and throw less info to the readers.

A big chunk was copy-pasted to huggingface_hub/src/README.md. That README should be updated in a follow-up PR with other pointers.

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! How about using this opportunity to do the screenshots with the new front?

@LysandreJik
Copy link
Member

I would also put links to all documentation READMEs

@osanseviero
Copy link
Member Author

I replaced the images and added reference to docs.

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@osanseviero osanseviero merged commit 8e26dc0 into main Jun 22, 2021
@osanseviero osanseviero deleted the new_readme branch June 22, 2021 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants