Skip to content

Commit

Permalink
docs: update readme (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau authored Mar 4, 2024
2 parents 3107c23 + 06b7e8e commit cd557ac
Show file tree
Hide file tree
Showing 2 changed files with 212 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,36 +1,34 @@
PyGADM
======

.. raw:: html

<p align="center">
<img src="docs/_static/logo.png" width=240 alt="header"></a>
</p>

<h1 align="center">pyGADM</h1>

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white
.. image:: https://img.shields.io/badge/License-MIT-yellow?logo=opensourceinitiative&logoColor=white
:target: LICENSE
:alt: License: MIT

.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=git&logoColor=white
.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow?logo=git&logoColor=white
:target: https://conventionalcommits.org
:alt: conventional commit

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
.. image:: https://img.shields.io/badge/code%20style-black-000000?logo=ford&logoColor=white
:target: https://github.com/psf/black
:alt: Black badge

.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white
.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4?logo=prettier&logoColor=white
:target: https://github.com/prettier/prettier
:alt: prettier badge

.. image:: https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white
:target: https://pre-commit.com/
:alt: pre-commit

.. image:: https://img.shields.io/pypi/v/pygadm?color=blue&logo=pypi&logoColor=white
.. image:: https://img.shields.io/pypi/v/pygadm?color=blue&logo=python&logoColor=white
:target: https://pypi.org/project/pygadm/
:alt: PyPI version

.. image:: https://img.shields.io/conda/vn/conda-forge/pygadm?color=blue&logo=anaconda&logoColor=white
:target: https://anaconda.org/conda-forge/pygadm
:alt: Conda Version

.. image:: https://img.shields.io/github/actions/workflow/status/12rambau/pygadm/unit.yaml?logo=github&logoColor=white
:target: https://github.com/12rambau/pygadm/actions/workflows/unit.yaml
:alt: build
Expand All @@ -46,6 +44,10 @@
Overview
--------

.. image:: docs/_static/logo.svg
:width: 20%
:align: right

Easy access to administrative boundary defined by GADM from a Python scripts.

This lib provides access to GADM datasets from a Python script without downloading the file from their server. We provide access to The current version (4.1.) which delimits 400,276 administrative areas.
Expand Down
197 changes: 197 additions & 0 deletions docs/_static/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cd557ac

Please sign in to comment.