Improve docs

Xaeroxe · Dec 30, 2022 · 7454509 · 7454509
1 parent 163d94f
commit 7454509
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "async-io-converse"
-version = "0.1.0"
+version = "1.0.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "Can conduct a conversation over any AsyncRead or AsyncWrite type with serde compatible types"

diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
-# async-io-converse
+# async-io-converse [![Build Status]][actions] [![Latest Version]][crates.io]
 
-![ci status](https://github.com/Xaeroxe/async-io-converse/actions/workflows/rust.yml/badge.svg)
+[Build Status]: https://img.shields.io/github/actions/workflow/status/Xaeroxe/async-io-converse/rust.yml?branch=main
+[actions]: https://github.com/Xaeroxe/async-io-converse/actions?query=branch%3Amain
+[Latest Version]: https://img.shields.io/crates/v/async-io-converse.svg
+[crates.io]: https://crates.io/crates/async-io-converse
+
+[Documentation](https://docs.rs/async-io-converse)
 
 A wrapper over the [`async-io-typed`](https://github.com/Xaeroxe/async-io-typed) crate which allows
 [`serde`](https://github.com/serde-rs/serde) compatible types to be sent over any duplex connection that has types that implement

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,4 @@
-//#![doc = include_str!("../README.md")]
+#![doc = include_str!("../README.md")]
 
 use async_io_typed::{AsyncReadTyped, AsyncWriteTyped};
 use futures_io::{AsyncRead, AsyncWrite};