From d04e7893cc06390b07e3a6f8327b23014216aa39 Mon Sep 17 00:00:00 2001
From: Markus / Mark <46672778+marksverdhei@users.noreply.github.com>
Date: Sat, 27 Jun 2026 19:05:43 +0200
Subject: [PATCH] docs(readme): document convert/inspect subcommands + library
 helpers

README was the stock python-template placeholder ('Hello from markutils')
and didn't mention either subcommand from #14 or the load/save helpers
that have been there longer.

Rewritten as: tool description first, then install, then develop.
---
 README.md | 41 ++++++++++++++++++++++-------------------
 1 file changed, 22 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 8fe7054..eab10f8 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,34 @@
 # markutils
 
-This project uses [`uv`](https://github.com/astral-sh/uv), which can be installed in one line: 
+Small grab-bag of data and model utilities. Two CLI subcommands so far:
+
 ```bash
-# On macOS and Linux.
-curl -LsSf https://astral.sh/uv/install.sh | sh
+# Convert between csv / tsv / json / jsonl / parquet (format inferred from extension)
+markutils convert input.csv output.parquet
+
+# Print tensor shapes from a safetensors checkpoint
+markutils inspect model.safetensors
 ```
 
-To get started with the project:
+Library-side: `markutils.utils.data.load_dataframe` / `save_dataframe` for the same
+format-roundtrip helpers, and `markutils.checkpoints.get_state_dict` /
+`print_state_dict_shapes` for safetensors inspection.
 
-```
-git clone https://github.com/marksverdhei/markutils.git
-cd markutils
-```
+## Install
 
-Then install project with
-```
-uv sync --dev
-source .venv/bin/activate
+```bash
+pip install git+https://github.com/marksverdhei/markutils.git
 ```
 
-Then you can run the default cli, which can be customized in `cli.py` and `pyproject.toml`  
-```
-$ markutils
-Hello from markutils
-```
+## Develop
+
+This project uses [`uv`](https://github.com/astral-sh/uv):
 
-How to install:
 ```bash
-pip install git+https://github.com/marksverdhei/markutils.git
+curl -LsSf https://astral.sh/uv/install.sh | sh
+git clone https://github.com/marksverdhei/markutils.git
+cd markutils
+uv sync --dev
+source .venv/bin/activate
+uv run pytest
 ```