Skip to content

Commit 50f1597

Browse files
authored
docs: add client customization instructions (#71)
* docs: add list filtering directions * docs: add client customization instructions
1 parent 83522d8 commit 50f1597

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

README.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,24 @@ go install github.com/charmbracelet/skate@latest
9292

9393
## Other Features
9494

95+
### List Filters
96+
```bash
97+
# list keys only
98+
skate list -k
99+
100+
# list values only
101+
skate list -v
102+
103+
# reverse lexicographic order
104+
skate list -r
105+
106+
# add a custom delimeter between keys and values; default is a tab
107+
skate list -d "\t"
108+
109+
# show binary values
110+
skate list -b
111+
```
112+
95113
### Databases
96114

97115
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:[email protected]).
165183

166184
## Self-Hosting
167185

168-
Skate is backed by the Charm Cloud. By default it will use the Charm hosted
186+
Skate is backed by the Charm Cloud. By default, it will use the Charm hosted
169187
cloud, but it’s incredibly easy to self-host, even if that’s just on your
170188
local network. For details, see the [Charm docs][selfhost].
171189

172190
[selfhost]: https://github.com/charmbracelet/charm#self-hosting
173191

174192
If you've finished setting up your very own Charm Cloud, great.
175-
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.
193+
To make `skate` connect to your self-hosted instance, you'll need to change the
194+
`CHARM_HOST` environment variable to point to the domain/IP of where you hosted
195+
your Charm Cloud. If you would like to change anything else about the Skate
196+
client, you can do so by changing the Charm client [environment
197+
variables][client-vars].
176198

177-
## Hey, Developers
199+
[client-vars]: https://github.com/charmbracelet/charm#client-settings
178200

179-
Skate is built on [charm/kv](https://github.com/charmbracelet/charm#charm-kv). If
180-
you’d like to build a tool that includes a user key value store, check it out.
181-
Skate has the same functionality as `charm kv`, but it uses a separate database.
201+
## Hey, Developers
182202

183-
## FAQ
203+
Skate is built on [Charm KV][charm-kv]. If you’d like to build a tool that
204+
includes a user key value store, check it out. Skate has the same functionality
205+
as `charm kv`, but it uses a separate database.
184206

185-
Skate is built off of [Charm FS][charm].
186-
Refer to [its FAQ][faq] for more info.
207+
If you have questions about the underlying file system Skate uses, head on over
208+
to our [Charm FS FAQ][faq].
187209

188-
[charm]: https://github.com/charmbracelet/charm
210+
[charm-kv]: https://github.com/charmbracelet/charm#charm-kv
189211
[faq]: https://github.com/charmbracelet/charm#faq
190212

191213
## Feedback

0 commit comments

Comments
 (0)