Skip to content

Commit

Permalink
Add badges to README.md
Browse files Browse the repository at this point in the history
In an effort to improve the visibility of the project's status, this update adds a series of informative badges to the README.md file. These badges provide immediate visual feedback on aspects such as PyPI and Conda version, tests, code coverage, documentation and more.
  • Loading branch information
Altay Sansal committed Feb 29, 2024
1 parent 9450fb3 commit b64bda2
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,30 @@
[[_TOC_]]
[![PyPI](https://img.shields.io/pypi/v/segy.svg)][install_pip]
[![Conda](https://img.shields.io/conda/vn/conda-forge/segy)][install_conda]
[![Python Version](https://img.shields.io/pypi/pyversions/multidimio)][python version]
[![Status](https://img.shields.io/pypi/status/segy.svg)][status]
[![License](https://img.shields.io/pypi/l/segy)][apache 2.0 license]

[![Tests](https://github.com/TGSAI/segy/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/TGSAI/segy/branch/main/graph/badge.svg)][codecov]
[![Read the documentation at https://segy.readthedocs.io/](https://img.shields.io/readthedocs/segy/latest.svg?label=Read%20the%20Docs)][read the docs]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)][ruff]

[![PyPI Downloads](https://static.pepy.tech/personalized-badge/segy?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads)][pypi_]
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/segy?label=Conda%20downloads&style=flat)][conda-forge_]

[pypi_]: https://pypi.org/project/segy/
[conda-forge_]: https://anaconda.org/conda-forge/segy
[status]: https://pypi.org/project/segy/
[python version]: https://pypi.org/project/segy
[read the docs]: https://segy.readthedocs.io/
[tests]: https://github.com/TGSAI/segy/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/TGSAI/segy
[pre-commit]: https://github.com/pre-commit/pre-commit
[ruff]: (https://github.com/astral-sh/ruff)
[install_pip]: https://segy.readthedocs.io/en/latest/installation.html#using-pip-and-virtualenv
[install_conda]: https://segy.readthedocs.io/en/latest/installation.html#using-conda

# SEG-Y

Expand Down Expand Up @@ -77,3 +103,7 @@ You can build your own SEG-Y "standard" with composition of specs for:
- Traces (header + extended header + samples)

Feel free to share the thoughts and raise the issues to improve the library.

<!-- github-only -->

[apache 2.0 license]: https://github.com/TGSAI/segy/blob/main/LICENSE

0 comments on commit b64bda2

Please sign in to comment.