docs: add usage instructions

This commit is contained in:
raf 2023-10-26 16:28:25 +03:00
parent 746520f13a
commit 5f605ec92e
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29

View file

@ -2,4 +2,18 @@
> Go port of https://github.com/delroth/grep-nixos-cache
"A tool to efficiently grep the contents of many NixOS store paths for a given string to find. The main use case is looking for vendored libraries through the entirety of a Hydra evaluation."
**I'm petty, sue me.**
# How to use
```console
grep-nixos-cache --needle "what-to-search" --path ""/nix/store/...""
```
# Why does this exist?
1. I don't want Rust on my system
2. I don't want flake-utils on my system
3. Felt like it