adding readme to docs folder (#230)

stargate · Mar 8, 2023 · d5c2792 · d5c2792
1 parent e36f2c3
commit d5c2792
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,9 @@
+# Stargate JSON API Documents
+
+This folder contains documentation for the JSON API.
+
+## Specifications
+
+* The [network specification](jsonapi-network-spec.textile) specifies the HTTP API for the JSON API, how clients can communicate with the service.
+* The [query specification](jsonapi-spec.textile) provides details on data modelling and queries.
+