Skip to content

Commit

Permalink
docs(readme): add short project description (#28)
Browse files Browse the repository at this point in the history
Fixes #14
  • Loading branch information
afuetterer authored May 19, 2024
1 parent 9b4d719 commit c20f23e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@
> ⚠️ Please note that this project is currently under active development. As such, it is considered a work in progress,
> and breaking changes may be introduced at any time. We encourage users to frequently check back for updates and to
> exercise caution when using this project in production environments. Contributions and feedback are welcome to help
> move the project towards a more stable release.
> move the project towards a more stable release (v1.0.0).
| __CI__ | [![pre-commit.ci status][pre-commit-ci-badge]][pre-commit-ci-status] [![ci][ci-badge]][ci-workflow] [![coverage][coverage-badge]][ci-workflow] [![codeql][codeql-badge]][codeql-workflow] |
| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| __Docs__ | [![docs][docs-badge]][docs-workflow] |
| __Meta__ | [![OpenSSF Scorecard][scorecard-badge]][scorecard-url] [![hatch][hatch-badge]][hatch] [![ruff][ruff-badge]][ruff] [![mypy][mypy-badge]][mypy] [![License][license-badge]][license-url] |

`python-re3data` is a Python library that simplifies interacting with the [re3data](https://www.re3data.org) (Registry
of Research Data Repositories) [REST API](https://www.re3data.org/api/doc), allowing you to easily retrieve and process
metadata about research data repositories in a convenient and Pythonic way.

**Table of Contents**

- [Installation](#installation)
Expand Down

0 comments on commit c20f23e

Please sign in to comment.