From 06e58f36068436526de622eb5e65993206b25bc2 Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Fri, 13 Sep 2024 18:18:08 -0500 Subject: [PATCH] docs: use markdown for readme file --- README.md | 11 +++++++++++ README.rst | 14 -------------- pyproject.toml | 2 +- 3 files changed, 12 insertions(+), 15 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4786ea --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ + +# rattail-woocommerce + +Rattail is a retail software framework, released under the GNU General Public +License. + +This package contains software interfaces for the +[WooCommerce](https://woocommerce.com/) system. + +Please see the [Rattail Project](https://rattailproject.org/) for more +information. diff --git a/README.rst b/README.rst deleted file mode 100644 index 4c84e9e..0000000 --- a/README.rst +++ /dev/null @@ -1,14 +0,0 @@ - -rattail-woocommerce -=================== - -Rattail is a retail software framework, released under the GNU General Public -License. - -This package contains software interfaces for the `WooCommerce`_ system. - -.. _WooCommerce: https://woocommerce.com/ - -Please see the `Rattail Project`_ for more information. - -.. _`Rattail Project`: https://rattailproject.org/ diff --git a/pyproject.toml b/pyproject.toml index b1c0c9f..17a034b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "hatchling.build" name = "rattail-woocommerce" version = "0.2.0" description = "Rattail Software Interfaces for WooCommerce" -readme = "README.rst" +readme = "README.md" authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] license = {text = "GNU GPL v3+"} classifiers = [