From f300181453f86d0f83b03950d0b11c00e1f479c0 Mon Sep 17 00:00:00 2001
From: Silas Boyd-Wickizer <silasbw@gmail.com>
Date: Tue, 14 Jun 2022 09:52:10 -0700
Subject: [PATCH] Document a versioning scheme and the pre 1.0.0 state (#56)

---
 README.md    | 23 +++++++++++++++++++++--
 package.json |  2 +-
 swagger.yaml |  2 +-
 3 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 1518962..2537c2d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# specification
-FiatConnect API Specification
+# FiatConnect
+
+The FiatConnect API Specification.
+
+## Specification
+
+[fiatconnect-api.md](./fiatconnect-api.md) describes the FiaConnect
+API specification.
+
+[swagger.yaml](./swagger.yaml) is an OpenAPI 2.0 specification for
+FiatConnect.
+
+## Versioning
+
+We use [semantic versioning](https://semver.org/) to version the
+API specification.
+
+The API specification is stil under initial developemnt. We're working
+towards a 1.0.0 release and try hard to avoid breaking changes, but
+anything MAY change at any time. The API specification SHOULD NOT be
+considered stable.
diff --git a/package.json b/package.json
index 7192f91..b6f6a91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "specification",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "FiatConnect API Specification",
   "repository": "https://github.com/fiatconnect/specification.git",
   "scripts": {
diff --git a/swagger.yaml b/swagger.yaml
index 386a5ff..d9123e8 100644
--- a/swagger.yaml
+++ b/swagger.yaml
@@ -1,7 +1,7 @@
 swagger: "2.0"
 info:
   description: "FiatConnect provides a standardized server-side API specification for CICO providers to provide cash-in/cash-out functionality to clients."
-  version: "1.0.0"
+  version: "0.1.0"
   title: "FiatConnect Specification"
 tags:
 - name: "clock"