aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..957b5b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+entq - Entity Query
+===================
+
+Emits the (potentially LZMA-compressed) entity lump of a [Source 1] map as a
+JSON array-of-objects for inspection by other tools.
+
+Install
+-------
+
+ go install partyvan.io/entq@latest
+
+Usage
+-----
+
+ entq /path/to/map.bsp
+
+
+[Source 1]: https://developer.valvesoftware.com/wiki/Source \ No newline at end of file