From b81b334cebb175edc0bd81977de4800849b147b3 Mon Sep 17 00:00:00 2001
From: spwoodcock <sam.woodcock@protonmail.com>
Date: Mon, 23 Oct 2023 08:36:00 +0100
Subject: [PATCH] docs: update readme with badages

---
 .dockerignore  |  2 +-
 README.md      | 48 +++++++++++++++++++++++++++++++++++++++++++++---
 mkdocs.yml     |  2 +-
 pyproject.toml |  2 +-
 4 files changed, 48 insertions(+), 6 deletions(-)

diff --git a/.dockerignore b/.dockerignore
index 1a9a75db..28a563ae 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -7,4 +7,4 @@
 !pdm.lock
 !entrypoint.sh
 !README.md
-!LICENSE.md
+!LICENSE
diff --git a/README.md b/README.md
index 9c286f8a..2a2175cf 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,48 @@
-# OSM Fieldwork Project
-
-🕮 [Documentation](https://hotosm.github.io/osm-fieldwork/)
+# OSM Fieldwork
+
+<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>Processing field data from OpenDataKit to OpenStreetMap format, and other field utils.</em>
+</p>
+<p align="center">
+  <a href="https://github.com/hotosm/osm-fieldwork/actions/workflows/build.yml" target="_blank">
+      <img src="https://github.com/hotosm/osm-fieldwork/workflows/Build/badge.svg" alt="Build">
+  </a>
+  <a href="https://github.com/hotosm/osm-fieldwork/actions/workflows/build-ci.yml" target="_blank">
+      <img src="https://github.com/hotosm/osm-fieldwork/workflows/Build CI Img/badge.svg" alt="CI Build">
+  </a>
+  <a href="https://github.com/hotosm/osm-fieldwork/actions/workflows/docs.yml" target="_blank">
+      <img src="https://github.com/hotosm/osm-fieldwork/workflows/Publish Docs/badge.svg" alt="Publish Docs">
+  </a>
+  <a href="https://github.com/hotosm/osm-fieldwork/actions/workflows/publish.yml" target="_blank">
+      <img src="https://github.com/hotosm/osm-fieldwork/workflows/Publish to PyPi.org/badge.svg" alt="Publish">
+  </a>
+  <a href="https://github.com/hotosm/osm-fieldwork/actions/workflows/pytest.yml" target="_blank">
+      <img src="https://github.com/hotosm/osm-fieldwork/workflows/pytest/badge.svg" alt="Test">
+  </a>
+  <a href="https://pypi.org/project/osm-fieldwork" target="_blank">
+      <img src="https://img.shields.io/pypi/v/osm-fieldwork?color=%2334D058&label=pypi%20package" alt="Package version">
+  </a>
+  <a href="https://pypistats.org/packages/osm-fieldwork" target="_blank">
+      <img src="https://img.shields.io/pypi/dm/osm-fieldwork.svg" alt="Downloads">
+  </a>
+  <a href="https://github.com/hotosm/osm-fieldwork/blob/main/LICENSE" target="_blank">
+      <img src="https://img.shields.io/github/license/hotosm/osm-fieldwork.svg" alt="License">
+  </a>
+</p>
+
+---
+
+🕮 **Documentation**: <a href="https://hotosm.github.io/osm-fieldwork/" target="_blank">https://hotosm.github.io/osm-fieldwork/</a>
+
+**Source Code**: <a href="https://github.com/hotosm/osm-fieldwork" target="_blank">https://github.com/hotosm/osm-fieldwork</a>
+
+---
+
+![PyPi](https://img.shields.io/pypi/v/osm-fieldwork?label=pypi%20package)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/osm-fieldwork)
 
 Osm-Fieldwork is a project for processing data collection using
 OpenDataKit into OpenStreetMap format. It includes several utility
diff --git a/mkdocs.yml b/mkdocs.yml
index 4fa1a508..646c4eba 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -68,7 +68,7 @@ nav:
       - FAQ: about/FAQ.md
       - Changelog: CHANGELOG.md
       - Code of Conduct: Code-of-Conduct.md
-      - License: LICENSE.md
+      - License: LICENSE
   - User Manual: about/user-manual.md
   - Core Program Usage:
       - ODK Client: about/odk_client.md
diff --git a/pyproject.toml b/pyproject.toml
index 91b03ca7..f1c88aee 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -72,7 +72,7 @@ version_files = [
 version = {from = "osm_fieldwork/__version__.py"}
 [tool.pdm.build]
 includes = ["osm_fieldwork"]
-source-includes = ["tests", "LICENSE.md", "README.md"]
+source-includes = ["tests", "LICENSE", "README.md"]
 excludes = ["osm_fieldwork/*.db", "osm_fieldwork/*.sql"]
 [tool.pdm.dev-dependencies]
 dev = [