From: Carl Worth <cworth@cworth.org>
Date: Sun, 10 May 2020 16:53:16 +0000 (-0700)
Subject: Add a version indication to the protocol description
X-Git-Url: https://git.cworth.org/git?p=empires-api;a=commitdiff_plain;h=7c9ed4f7f7428da79eaa06376991b4ed0965fa47

Add a version indication to the protocol description

Starting with version 0.3 since there have been a couple of previosu
versions, (but also less than 1.0 since we haven't yet implemented a
functional game).
---

diff --git a/api.text b/api.text
index 48a2eb6..41e365c 100644
--- a/api.text
+++ b/api.text
@@ -1,5 +1,11 @@
-Gameplay API endpoints (within a current game)
-==============================================
+Empires Game Protocol
+=====================
+Version: 0.3
+
+For a specific game the following API endpoints are defined.
+(Note: Only the trailing portion of the API URI is provided here.
+ The preceding portions of the path must be determined externally.)
+
 /events
 
     This is a server-sent events stream that allows the server to push