docs: update pystapi-client readme

CONTRIBUTING.md

@@ -42,6 +42,13 @@ We use [mypy](https://mypy-lang.org/) for static typing.
 When possible, projects work in `strict` mode, meaning that type checking is strongly enforced.
 Some projects are not quite ready for `strict` mode, but we want to get them there.
 
+## Docs
+
+We use [mkdocs](https://www.mkdocs.org/) for our [documentation](/docs/). 
+To build the docs, run `uv run mkdocs build`.
+To serve the docs locally, run `uv run mkdocs serve`.
+
+
 ## Lints and checks
 
 We use [pre-commit](https://pre-commit.com/).

README.md

@@ -46,6 +46,13 @@ uv run fastapi dev stapi-fastapi/tests/application.py
 
 The app should be accessible at `http://localhost:8000`.
 
+### stapi-client
+
+The `stapi-client` package is a Python client (CLI tool) focused on interfacing with the STAPI specification, specifically with a STAPI server. This is a work in progress.
+
+For more information, see the [README](pystapi-client/README.md).
+
+
 ## Packages
 
 ```mermaid

docs/stapi-client/index.md

@@ -0,0 +1,14 @@
+# stapi-client
+
+A Python client (CLI tool) for interfacing with a [Satellite Tasking API (STAPI)](https://github.com/stapi-spec) server.
+
+!!! note
+
+    This is a work in progress.
+
+## Installation
+
+```shell
+uv pip install pystapi-client
+```
+

docs/stapi-pydantic/index.md

@@ -5,4 +5,4 @@
 !!! note
 
     This repository intentionally has no input/output (IO) functionality.
-    For making requests to a STAPI API, use **pystapi-client**.
+    For making requests to a STAPI API, use **[pystapi-client](../stapi-client/index.md)**.

mkdocs.yml

@@ -14,6 +14,8 @@ nav:
   - stapi-pydantic:
       - stapi-pydantic/index.md
       - stapi-pydantic/api.md
+  - stapi-client:
+      - stapi-client/index.md
 
 plugins:
   - mkdocstrings:

pystapi-client/README.md

@@ -0,0 +1,29 @@
+# pystapi-client
+
+[![CI](https://github.com/stapi-spec/pystapi/actions/workflows/ci.yaml/badge.svg)](https://github.com/stapi-spec/pystapi/actions/workflows/ci.yaml)
+[![Release](https://github.com/stapi-spec/pystapi/actions/workflows/release.yaml/badge.svg)](https://github.com/stapi-spec/pystapi/actions/workflows/release.yaml)
+<!--TODO: Add PyPI badge when package is released-->
+<!-- [![PyPI version](https://badge.fury.io/py/pystapi-client.svg)](https://badge.fury.io/py/pystapi-client) -->
+[![Documentation](https://stapi-spec.github.io/pystapi/stapi-client/)](https://stapi-spec.github.io/pystapi/stapi-client/)
+[![codecov](https://codecov.io/gh/stapi-spec/pystapi/branch/main/graph/badge.svg)](https://codecov.io/gh/stapi-spec/pystapi)
+
+A Python client for working with [STAPI](https://stapi-spec.github.io/pystapi/) APIs.
+
+## Installation
+
+Install from PyPi.
+Other than [stapi-pydantic](https://stapi-spec.github.io/pystapi/stapi-pydantic/) itself, the only dependencies for **pystapi-client** are the Python [httpx](https://www.python-httpx.org/) and [python-dateutil](https://dateutil.readthedocs.io) libraries.
+
+### Local Development
+
+```shell
+uv pip install pystapi-client
+```
+
+## Documentation
+
+See the [documentation page](https://stapi-spec.github.io/pystapi/stapi-client/) for the latest docs.
+
+## Development
+
+See the [contributing page](../CONTRIBUTING.md) for the latest development instructions.