use md

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2022, Quantmind
+Copyright (c) 2009-2023, Quantmind
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

pyproject.toml

@@ -4,7 +4,7 @@ version = "1.4.0"
 description = "Python currencies"
 authors = ["Luca Sbardella <[email protected]>"]
 license = "BSD"
-readme = "README.rst"
+readme = "readme.md"
 packages = [
     { include = "ccy" }
 ]

readme.md

@@ -0,0 +1,13 @@
+# Python CCY
+
+[![PyPI version](https://badge.fury.io/py/ccy.svg)](https://badge.fury.io/py/ccy)
+[![Python versions](https://img.shields.io/pypi/pyversions/ccy.svg)](https://pypi.org/project/ccy)
+[![build](https://github.com/quantmind/ccy/actions/workflows/build.yml/badge.svg)](https://github.com/quantmind/ccy/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/quantmind/ccy/branch/main/graph/badge.svg?token=2L5SY0WkXv)](https://codecov.io/gh/quantmind/ccy)
+
+A python module for currencies. The module compiles a dictionary of
+currency objects containing information useful in financial analysis.
+Not all currencies in the world are supported yet. You are welcome to
+join and add more.
+
+Documentation is available as [ccy jupyter book](https://quantmind.github.io/ccy/).