Skip to content

Commit

Permalink
docs: update readme with badages
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Oct 23, 2023
1 parent f66cd0c commit b81b334
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
!pdm.lock
!entrypoint.sh
!README.md
!LICENSE.md
!LICENSE
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down

0 comments on commit b81b334

Please sign in to comment.