oxidized-importer: add README.md

indygreg · indygreg · commit b9a17d344358 · 2020-05-08T18:53:32.000-07:00
diff --git a/oxidized-importer/Cargo.toml b/oxidized-importer/Cargo.toml
@@ -5,6 +5,7 @@ authors = ["Gregory Szorc <gregory.szorc@gmail.com>"]
 edition = "2018"
 license = "Python-2.0 AND MPL-2.0"
 description = "A Rust-powered Python importer"
+readme = "README.md"
 
 [lib]
 name = "oxidized_importer"
diff --git a/oxidized-importer/README.md b/oxidized-importer/README.md
@@ -0,0 +1,15 @@
+# Oxidized Importer
+
+`oxidized-importer` is a Rust crate that produces a Python extension
+module for the ``oxidized_importer`` Python module. This module provides
+a Python *meta path finder* that can load Python resources from a pre-built
+index, including loading resources from memory. It also exposes functionality
+for scanning the filesystem for Python resources, loading those resources
+into the custom *meta path finder*, and serializing indexed data into a
+binary data structure that can be used for quickly loading an index of
+available Python resources.
+
+This project is part of the
+[PyOxidized](https://github.com/indygreg/PyOxidizer) project. For more,
+see the documentation in the `docs/` directory, rendered online at
+https://pyoxidizer.readthedocs.io/en/latest/oxidized_importer.html.
diff --git a/setup.py b/setup.py
@@ -70,13 +70,18 @@ def build_extension(self, ext):
         )
 
 
+with open("oxidized-importer/README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+
 setuptools.setup(
     name="oxidized_importer",
-    version="0.1",
+    version="0.1dev0",
     author="Gregory Szorc",
     author_email="gregory.szorc@gmail.com",
     url="https://github.com/indygreg/PyOxidizer",
     description="Python importer implemented in Rust",
+    long_description=long_description,
     license="MPL 2.0",
     python_requires=">=3.8",
     classifiers=["Intended Audience :: Developers", "Programming Language :: Rust",],
