From 7e6530ff1ec99660ef24d9ec2d981d35a81797ac Mon Sep 17 00:00:00 2001
From: Dave Tucker <dave@dtucker.co.uk>
Date: Tue, 17 May 2022 19:22:15 +0200
Subject: [PATCH] readme: Add unreleased docs link

This rearranges the README to use fancy badges!
And adds links to the docs published on netlify.

Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
---
 .github/workflows/build-aya-bpf.yml |  2 +-
 .github/workflows/build-aya.yml     |  4 ++--
 .github/workflows/images.yml        |  4 ++--
 .github/workflows/lint.yml          |  4 ++--
 .github/workflows/release.yml       |  2 +-
 README.md                           | 34 +++++++++++++++++++----------
 6 files changed, 31 insertions(+), 19 deletions(-)

diff --git a/.github/workflows/build-aya-bpf.yml b/.github/workflows/build-aya-bpf.yml
index e54054cb..68d85c59 100644
--- a/.github/workflows/build-aya-bpf.yml
+++ b/.github/workflows/build-aya-bpf.yml
@@ -1,4 +1,4 @@
-name: Build aya-bpf
+name: build-aya-bpf
 
 on:
   push:
diff --git a/.github/workflows/build-aya.yml b/.github/workflows/build-aya.yml
index 6f8c5235..82eb94b1 100644
--- a/.github/workflows/build-aya.yml
+++ b/.github/workflows/build-aya.yml
@@ -1,4 +1,4 @@
-name: Build aya
+name: build-aya
 
 on:
   push:
@@ -39,4 +39,4 @@ jobs:
         run: |
           ln -s /root/.rustup ${HOME}/.rustup
           cd test
-          rtf -vvv run
\ No newline at end of file
+          rtf -vvv run
diff --git a/.github/workflows/images.yml b/.github/workflows/images.yml
index 08f5e144..d13d3aae 100644
--- a/.github/workflows/images.yml
+++ b/.github/workflows/images.yml
@@ -1,4 +1,4 @@
-name: Aya test image
+name: aya-test-image
 
 on:
   schedule:
@@ -50,4 +50,4 @@ jobs:
           file: images/Dockerfile.rtf
           push: true
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
\ No newline at end of file
+          labels: ${{ steps.meta.outputs.labels }}
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 06d58809..59b3d16f 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -1,4 +1,4 @@
-name: Lint
+name: lint
 
 on:
   push:
@@ -50,4 +50,4 @@ jobs:
           cargo miri test --all-targets
           pushd bpf
           cargo miri test
-          popd
\ No newline at end of file
+          popd
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 84fa8b79..5933e1a4 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,4 +1,4 @@
-name: 'release'
+name: release
 on:
   push:
     tags:
diff --git a/README.md b/README.md
index 478c8e90..cc069b1f 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,36 @@
 [![Crates.io][crates-badge]][crates-url]
 ![License][license-badge]
 ![Build status][build-badge]
-[![Documentaiton][docs-badge]][docs-url]
+[![Book][book-badge]][book-url]
 
-[crates-badge]: https://img.shields.io/crates/v/aya.svg
+
+[crates-badge]: https://img.shields.io/crates/v/aya.svg?style=for-the-badge&logo=rust
 [crates-url]: https://crates.io/crates/aya
-[license-badge]: https://img.shields.io/badge/license-MIT%2FApache--2.0-blue
-[build-badge]: https://github.com/aya-rs/aya/actions/workflows/build-aya.yml/badge.svg
-[docs-badge]: https://img.shields.io/badge/docs-website-blue.svg
-[docs-url]: http://aya-rs.github.io/book/
+[license-badge]: https://img.shields.io/badge/license-MIT%2FApache--2.0-blue?style=for-the-badge
+[build-badge]: https://img.shields.io/github/workflow/status/aya-rs/aya/build-aya?style=for-the-badge&logo=github
+[book-badge]: https://img.shields.io/badge/read%20the-book-9cf.svg?style=for-the-badge&logo=mdbook
+[book-url]: http://aya-rs.github.io/book/
+
+## API Documentation
 
-[API docs][api-docs] | [Chat][chat-url] | [Aya-Related Projects][awesome-aya]
+[![Unreleased Documentation][git-docs-badge]][git-api-docs] [![Documentaiton][api-docs-badge]][api-docs]
 
+[git-docs-badge]: https://img.shields.io/badge/docs-unreleased-red.svg?style=for-the-badge&logo=docsdotrs
+[git-api-docs]: https://aya-rs.netlify.app
+[api-docs-badge]: https://img.shields.io/badge/docs-released-blue.svg?style=for-the-badge&logo=docsdotrs
 [api-docs]: https://docs.rs/aya
+
+## Community
+
+[![Discord][discord-badge]][chat-url] [![Awesome][awesome-badge]][awesome-aya]
+
+Join [the conversation on Discord][chat-url] to discuss anything related to Aya, or discover
+and contribute to a list of [Awesome Aya][awesome-aya] projects.
+
+[discord-badge]: https://img.shields.io/badge/Discord-chat-5865F2?style=for-the-badge&logo=discord
 [chat-url]: https://discord.gg/xHW2cb2N6G
 [awesome-aya]: https://github.com/aya-rs/awesome-aya
+[awesome-badge]: https://img.shields.io/badge/Awesome-Aya-FC60A8?style=for-the-badge&logo=awesomelists
 
 ## Overview
 
@@ -78,10 +94,6 @@ let cgroup = File::open("/sys/fs/cgroup/unified")?;
 ingress.attach(cgroup, CgroupSkbAttachType::Ingress)?;
 ```
 
-## Community
-
-Join [the conversation on Discord][chat-url] to discuss anything related to aya.
-
 ## Contributing
 
 Please see the [contributing guide](https://github.com/aya-rs/aya/blob/main/CONTRIBUTING.md).