From 91da5253cbcf386019202bb1071d60a58c52fc38 Mon Sep 17 00:00:00 2001
From: stringertheory <mike.stringer.internet@gmail.com>
Date: Wed, 7 Jun 2023 15:16:21 -0500
Subject: [PATCH] documentation tweaks

---
 README.md       |  2 +-
 docs/index.md   | 40 ++++++++++++++++++++++++++++++++++------
 docs/modules.md |  4 +++-
 3 files changed, 38 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 2234401..579635a 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,7 @@ For more details, see the [full
 documentation](https://stringertheory.github.io/json-explorer/>).
 
 
-### Other tools to help with 
+### Other tools to help with JSON data
 
 This tool is intended for quick and dirty exploration of JSONs. If
 that's not what you need, there are a *lot* of great resources for
diff --git a/docs/index.md b/docs/index.md
index b33b969..4583743 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,8 +1,36 @@
-# json-explorer
-
-[![Release](https://img.shields.io/github/v/release/stringertheory/json-explorer)](https://img.shields.io/github/v/release/stringertheory/json-explorer)
 [![Build status](https://img.shields.io/github/actions/workflow/status/stringertheory/json-explorer/main.yml?branch=main)](https://github.com/stringertheory/json-explorer/actions/workflows/main.yml?query=branch%3Amain)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/stringertheory/json-explorer)](https://img.shields.io/github/commit-activity/m/stringertheory/json-explorer)
-[![License](https://img.shields.io/github/license/stringertheory/json-explorer)](https://img.shields.io/github/license/stringertheory/json-explorer)
+[![codecov](https://codecov.io/gh/stringertheory/json-explorer/branch/main/graph/badge.svg)](https://codecov.io/gh/stringertheory/json-explorer)
+
+# JSON Explorer
+
+Explore the structure and contents of a group of JSONs, like responses
+from an API.
+
+### Installation
+
+```
+pip install json-explorer
+```
+
+JSON Explorer is a small tool with no dependencies and is tested in
+Python 3.7+.
+
+### Getting started
+
+Get started by writing a few JSONs you want to explore to a file, one
+per line. Then run `json-explorer` from the command line:
+
+```
+json-explorer data_from_an_undocumented_API.jsonl
+```
+
+If you just want to try it out but don't have JSONs in a file, you can
+run `json-explorer --example` to see how it works with example data.
+
+This will pop up a web page that helps you explore the properties of
+the objects, what data types are in there, what values are unique, and
+more.
+
+From there, you might use `jq` or `jmespath` to write something to
+more read the data that you're interested in using.
 
-Explore the structure of a bunch of jsons.
diff --git a/docs/modules.md b/docs/modules.md
index 782a8a7..6d79215 100644
--- a/docs/modules.md
+++ b/docs/modules.md
@@ -1 +1,3 @@
-::: json_explorer
\ No newline at end of file
+::: json_explorer
+
+::: json_explorer.explore.TripleCounter