From f7de27d334d87e08ce4a42b5afcc3d61ee6f0c00 Mon Sep 17 00:00:00 2001 From: Bauke Date: Sun, 25 Sep 2022 23:44:09 +0200 Subject: [PATCH] Rewrite readme. --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 523efca..838eed6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# opyml +# OPyML 🐍 -An OPML library for Python. +> **OPML library for Python.** -This is a largely identical "port" of [the Rust crate](https://github.com/Holllo/opml). +## Features + +* Supports all OPML versions. +* Minimal use of dependencies. +* 100% typed and tested. ## Example @@ -20,16 +24,18 @@ xml = document.to_xml() document = OPML.from_xml(xml) ``` -For complete examples check out the `tests/` directory. - ## Development -* Install dependencies with [Poetry](https://python-poetry.org) (`poetry shell` + `poetry install`). +* Install dependencies with `poetry shell && poetry install`. * Format code with `black opyml tests`. * Check types with `mypy opyml`. -* Run tests and collect coverage with `pytest --cov=opyml --cov-report html`. +* Run tests and collect coverage with `pytest --cov opyml --cov-report html`. * Generate documentation with `pdoc opyml`. +## Feedback + +Found a problem or want to request a new feature? Email [helllo@holllo.org](mailto:helllo@holllo.org) and I'll see what I can do for you. + ## License -Dual-licensed with the [Apache License, Version 2.0](https://github.com/Holllo/opyml/blob/main/LICENSE-Apache) and [MIT license](https://github.com/Holllo/opyml/blob/main/LICENSE-MIT). +Distributed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) and [MIT](https://spdx.org/licenses/MIT.html) licenses, see [LICENSE-Apache](https://git.bauke.xyz/Holllo/opyml/src/branch/main/LICENSE-Apache) and [LICENSE-MIT](https://git.bauke.xyz/Holllo/opyml/src/branch/main/LICENSE-MIT) for more information.