Add README.md for crates.io; fixes #111 (#112)

oxidecomputer · Jun 2, 2021 · e0201cf · e0201cf
1 parent bdbda2f
commit e0201cf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/dropshot/Cargo.toml b/dropshot/Cargo.toml
@@ -6,6 +6,9 @@ authors = ["David Pacheco <[email protected]>"]
 edition = "2018"
 license = "Apache-2.0"
 repository = "https://github.com/oxidecomputer/dropshot/"
+readme = "README-crates.io.md"
+keywords = ["rest", "openapi", "async"]
+categories = ["network-programming", "web-programming::http-server"]
 
 [dependencies]
 async-trait = "0.1.24"

diff --git a/dropshot/README-crates.io.md b/dropshot/README-crates.io.md
@@ -0,0 +1,5 @@
+Dropshot is a general-purpose--but opinionated--crate for exposing REST APIs from a Rust program. It is meant to be simple and lightweight. It includes first-class support for [OpenAPI](https://spec.openapis.org/oas/v3.0.3) in the form of precise specs generated directly from code. It supports primitives for consistent pagination including extensions an OpenAPI extension denoting it in the spec.
+
+For information about configuration, design, and contributing, see the [GitHub repo](https://github.com/oxidecomputer/dropshot).
+
+For information on the use the API see the [documentation](https://docs.rs/dropshot).