@@ 0,0 1,18 @@
+# xettel-web-preview
+
+Small server written in `go` that reads a file containing the metadata of
+zettels and expose them via a simple API `/?id=$ID` where `ID` is a base 10
+numeric identifier or a base 36 case-insensitive identifier.
+
+```
+Usage of previewer:
+ -data string
+ Path to the JSON file containing xettel's data (default "summaries.json")
+ -port int
+ Port to listen to (default 54256)
+```
+
+This can be used as part of the updating process in order to minimise the
+number of files modified, in order to get a preview when hovering links.
+
+
