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

docs: improve badges and synopsis #74

Merged
merged 1 commit into from
Jun 23, 2018
Merged

Conversation

lucab
Copy link
Contributor

@lucab lucab commented Jun 15, 2018

This re-arranges the first section of README, so that the short synopsis
provides a quick and complete overview of the crate, and further info
is linked through badges.

This re-arranges the first section of README, so that the short synopsis
provides a quick and complete overview of the crate, and further info
is linked through badges.
@cuviper
Copy link
Member

cuviper commented Jun 15, 2018

Works for me -- maybe we should link the readme in Cargo.toml too? Does crates.io understand rst?

@lucab
Copy link
Contributor Author

lucab commented Jun 15, 2018

It doesn't. It expects CommonMark syntax. See rust-lang/crates.io#869.

@lucab
Copy link
Contributor Author

lucab commented Jun 22, 2018

Bump on this.

@cuviper
Copy link
Member

cuviper commented Jun 23, 2018

OK, we should think about converting the README, but that doesn't have to happen now.

Thanks!

@cuviper cuviper merged commit d9c1fc6 into indexmap-rs:master Jun 23, 2018
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.

2 participants