readme

README.md

@@ -0,0 +1,34 @@
+# depot-prefetch
+
+Retrieve the latest version of a games depots from steam and prefetch it's
+hashes.
+
+## Usage
+
+```bash
+cargo r -- <app id> --depot <depot id>
+```
+
+`--depot` can be specified multiple times, or left out to fetch all available
+depots.
+
+You can find depot id's for an app on
+[steamdb](https://steamdb.info/app/232250/depots/).
+
+## Output
+
+```json
+[
+  {
+    "app_id": <app id>,
+    "depot_id": <depot id>,
+    "manifest": <latest manifest id for the depot>,
+    "hash": <nix hash of the manifest>
+  },
+  ...
+]
+```
+
+This data can then be passed to
+[steam-fetcher](https://github.com/nix-community/steam-fetcher) to use the depot
+in your derivation.