docs: use markdown for readme file

This commit is contained in:
Lance Edgar 2024-09-13 18:40:32 -05:00
parent e2ce4fd257
commit 515ccc9f0c
3 changed files with 12 additions and 15 deletions

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# rattail-fabric2
Rattail is a retail software framework, released under the GNU General Public
License.
This package contains various utility functions for use with
[Fabric](http://www.fabfile.org/) (v2).
Please see Rattail's [home page](https://rattailproject.org/) for more
information.

View file

@ -1,14 +0,0 @@
rattail-fabric2
===============
Rattail is a retail software framework, released under the GNU General Public
License.
This package contains various utility functions for use with `Fabric`_ (v2).
.. _`Fabric`: http://www.fabfile.org/
Please see Rattail's `home page`_ for more information.
.. _`home page`: https://rattailproject.org/

View file

@ -8,7 +8,7 @@ build-backend = "hatchling.build"
name = "rattail-fabric2" name = "rattail-fabric2"
version = "0.4.3" version = "0.4.3"
description = "Fabric (v2) Utilities for Rattail" description = "Fabric (v2) Utilities for Rattail"
readme = "README.rst" readme = "README.md"
authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
license = {text = "GNU GPL v3+"} license = {text = "GNU GPL v3+"}
classifiers = [ classifiers = [