docs: switch PyPI readme from root/README to docs/index

AutoResearch · May 2, 2023 · 3de7270 · 3de7270
1 parent eac749b
commit 3de7270
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -14,8 +14,7 @@ Install the synthetic data package:
 pip install -U "autora-synthetic-data"
 ```
 
-!!! success
-    It is recommended to use a `python` environment manager like `virtualenv`.
+> 💡We recommend using a `python` environment manager like `virtualenv`.
 
 Check your installation by running:
 ```shell

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ description = "AutoRA Synthetic Data"
 authors = []
 dynamic = ["version"]
 
-readme = "README.md"
+readme = "docs/index.md"
 license = { text = "MIT License" }
 
 # ADD NEW DEPENDENCIES HERE