From 7f6f6d523e0db999806e09acbde07d9e27509c7a Mon Sep 17 00:00:00 2001
From: spwoodcock <sam.woodcock@protonmail.com>
Date: Wed, 13 Dec 2023 10:31:23 +0000
Subject: [PATCH] docs: update readme with badges

---
 README.md      | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 pyproject.toml |  2 +-
 2 files changed, 46 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 23852a23..d2175bb9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,48 @@
-# Building TM-Admin
+# TM Admin
+
+<!-- markdownlint-disable -->
+<p align="center">
+  <img src="https://github.com/hotosm/fmtm/blob/main/images/hot_logo.png?raw=true" style="width: 200px;" alt="HOT"></a>
+</p>
+<p align="center">
+  <em>Administrative modules for Tasking Manager style projects.</em>
+</p>
+<p align="center">
+  <a href="https://github.com/hotosm/tm-admin/actions/workflows/build.yml" target="_blank">
+      <img src="https://github.com/hotosm/tm-admin/workflows/Build/badge.svg" alt="Build">
+  </a>
+  <a href="https://github.com/hotosm/tm-admin/actions/workflows/build-ci.yml" target="_blank">
+      <img src="https://github.com/hotosm/tm-admin/workflows/Build CI Img/badge.svg" alt="CI Build">
+  </a>
+  <a href="https://github.com/hotosm/tm-admin/actions/workflows/docs.yml" target="_blank">
+      <img src="https://github.com/hotosm/tm-admin/workflows/Publish Docs/badge.svg" alt="Publish Docs">
+  </a>
+  <a href="https://github.com/hotosm/tm-admin/actions/workflows/publish.yml" target="_blank">
+      <img src="https://github.com/hotosm/tm-admin/workflows/Publish to PyPi.org/badge.svg" alt="Publish">
+  </a>
+  <a href="https://github.com/hotosm/tm-admin/actions/workflows/pytest.yml" target="_blank">
+      <img src="https://github.com/hotosm/tm-admin/workflows/PyTest/badge.svg" alt="Test">
+  </a>
+  <a href="https://pypi.org/project/tm-admin" target="_blank">
+      <img src="https://img.shields.io/pypi/v/tm-admin?color=%2334D058&label=pypi%20package" alt="Package version">
+  </a>
+  <a href="https://pypistats.org/packages/tm-admin" target="_blank">
+      <img src="https://img.shields.io/pypi/dm/tm-admin.svg" alt="Downloads">
+  </a>
+  <a href="https://github.com/hotosm/tm-admin/blob/main/LICENSE" target="_blank">
+      <img src="https://img.shields.io/github/license/hotosm/tm-admin.svg" alt="License">
+  </a>
+</p>
+
+---
+
+📖 **Documentation**: <a href="https://hotosm.github.io/tm-admin/" target="_blank">https://hotosm.github.io/tm-admin/</a>
+
+🖥️ **Source Code**: <a href="https://github.com/hotosm/tm-admin" target="_blank">https://github.com/hotosm/tm-admin</a>
+
+---
+
+<!-- markdownlint-enable -->
 
 This is a complicated project as it involves parsing and outputting
 multiple file formats. This project uses [gRPC](https://grpc.io/) for
diff --git a/pyproject.toml b/pyproject.toml
index 9710b0f7..d5dcbc4c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
 name = "tm-admin"
 dynamic = ["version"]
-description = "Support functions for tasking manager style projects"
+description = "Administrative modules for Tasking Manager style projects."
 authors = [
     {name = "Rob Savoye", email = "rob.savoye@hotosm.org"},
 ]