From 50f1597d44ed1e4d27d1af5eb33b35aa65947f77 Mon Sep 17 00:00:00 2001
From: bashbunni <15822994+bashbunni@users.noreply.github.com>
Date: Wed, 24 May 2023 14:33:47 -0700
Subject: [PATCH] docs: add client customization instructions (#71)

* docs: add list filtering directions

* docs: add client customization instructions
---
 README.md | 42 ++++++++++++++++++++++++++++++++----------
 1 file changed, 32 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 185033f..f12561a 100644
--- a/README.md
+++ b/README.md
@@ -92,6 +92,24 @@ go install github.com/charmbracelet/skate@latest
 
 ## Other Features
 
+### List Filters
+```bash
+# list keys only
+skate list -k
+
+# list values only
+skate list -v
+
+# reverse lexicographic order
+skate list -r
+
+# add a custom delimeter between keys and values; default is a tab
+skate list -d "\t"
+
+# show binary values
+skate list -b
+```
+
 ### Databases
 
 Sometimes you’ll want to separate your data into different databases:
@@ -165,27 +183,31 @@ What do you use `skate` for? [Let us know](mailto:vt100@charm.sh).
 
 ## Self-Hosting
 
-Skate is backed by the Charm Cloud. By default it will use the Charm hosted
+Skate is backed by the Charm Cloud. By default, it will use the Charm hosted
 cloud, but it’s incredibly easy to self-host, even if that’s just on your
 local network. For details, see the [Charm docs][selfhost].
 
 [selfhost]: https://github.com/charmbracelet/charm#self-hosting
 
 If you've finished setting up your very own Charm Cloud, great.
-To make `skate` connect to your self-hosted instance, you'll need to change the `CHARM_HOST` environment variable to point to the domain/IP of where you hosted your Charm Cloud.
+To make `skate` connect to your self-hosted instance, you'll need to change the
+`CHARM_HOST` environment variable to point to the domain/IP of where you hosted
+your Charm Cloud. If you would like to change anything else about the Skate
+client, you can do so by changing the Charm client [environment
+variables][client-vars].
 
-## Hey, Developers
+[client-vars]: https://github.com/charmbracelet/charm#client-settings
 
-Skate is built on [charm/kv](https://github.com/charmbracelet/charm#charm-kv). If
-you’d like to build a tool that includes a user key value store, check it out.
-Skate has the same functionality as `charm kv`, but it uses a separate database.
+## Hey, Developers
 
-## FAQ
+Skate is built on [Charm KV][charm-kv]. If you’d like to build a tool that
+includes a user key value store, check it out. Skate has the same functionality
+as `charm kv`, but it uses a separate database.
 
-Skate is built off of [Charm FS][charm].
-Refer to [its FAQ][faq] for more info.
+If you have questions about the underlying file system Skate uses, head on over
+to our [Charm FS FAQ][faq].
 
-[charm]: https://github.com/charmbracelet/charm
+[charm-kv]: https://github.com/charmbracelet/charm#charm-kv
 [faq]: https://github.com/charmbracelet/charm#faq
 
 ## Feedback