build: fix description (#6)

* build: fix description
* docs: Add installation and development instructions to README.md
* ci: restrict mypy to src
* test: Add test for package version

Signed-off-by: nstarman <nstarman@users.noreply.github.com>

README.md

@@ -0,0 +1,37 @@
+<h1 align='center'> spexial </h1>
+<h3 align="center">`scipy.special` in JAX</h3>
+
+<br>
+
+## Installation
+
+[![PyPI version][pypi-version]][pypi-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+
+```bash
+pip install spexial
+```
+
+or
+
+```bash
+uv add spexial
+```
+
+## Development
+
+[![codecov][codecov-badge]][codecov-link]
+[![Actions Status][actions-badge]][actions-link]
+
+We welcome contributions!
+
+<!-- prettier-ignore-start -->
+[actions-badge]:            https://github.com/JAXtronomy/spexial/workflows/CI/badge.svg
+[actions-link]:             https://github.com/JAXtronomy/spexial/actions
+[codecov-badge]:            https://codecov.io/gh/JAXtronomy/spexial/graph/badge.svg
+[codecov-link]:             https://codecov.io/gh/JAXtronomy/spexial
+[pypi-link]:                https://pypi.org/project/spexial/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/spexial
+[pypi-version]:             https://img.shields.io/pypi/v/spexial
+
+<!-- prettier-ignore-end -->

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "spexial"
 dynamic = ["version"]
-description = "`scipy.special` in JAX."
+description = "scipy.special in JAX."
 readme = "README.md"
 license.file = "LICENSE"
 requires-python = ">=3.11"
@@ -28,6 +28,7 @@ run.source          = ["spexial"]
 strict = false
 enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
 warn_unreachable = true
+files = ["src"]
 
 
 
@@ -66,6 +67,7 @@ ignore = [
 "src/spexial/_version.py" = ["SIM108"]
 "src/spexial/_src/gegenbauer.py" = ["ANN001", "ANN202", "ARG001", "D205", "D400", "D401", "D415", "N802", "N803", "N806"]
 "docs/*.py" = ["D104"]
+"tests/*.py" = ["ANN", "S101"]
 
 [tool.ruff.lint.isort]
 combine-as-imports = true

tests/test_package.py

@@ -0,0 +1,10 @@
+"""Test the package itself."""
+
+import importlib.metadata
+
+import spexial
+
+
+def test_version():
+    """Test version."""
+    assert importlib.metadata.version("spexial") == spexial.__version__