update python README

xraypy · Jan 5, 2025 · 971f158 · 971f158
1 parent 45ed444
commit 971f158
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/python/README b/python/README
diff --git a/python/README.md b/python/README.md
@@ -0,0 +1,10 @@
+## XrayDB Python module
+
+Python interface to XrayDB: X-ray Reference Data for the Elements
+
+To install, use
+```
+pip install xraydb
+```
+
+License: MIT
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -22,8 +22,8 @@ addopts = "--cov=xraydb --cov-report html"
 name = "xraydb"
 dynamic = ["version"]
 requires-python = ">= 3.9"
-description = "calculations with reference data for X-ray interactions with matter"
-readme = "README"
+description = "calculations with XrayDB: reference data for X-ray interactions with matter"
+readme = "README.md"
 authors = [
      {name = "Matthew Newville", email = "[email protected]"}
 ]