From d8a5d484c25cdf817cf824f439a57e00f4568005 Mon Sep 17 00:00:00 2001 From: Sebastian Fichtner Date: Tue, 4 Oct 2022 12:46:04 +0200 Subject: [PATCH] Document development status and start semantic versioning --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c5fd12..0ba5486 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # LSPServiceKit -A package that helps Swift clients use [LSPService](https://github.com/codeface-io/LSPService). +👩🏻‍🚀 *This project [is still a tad experimental](#development-status). Contributors and pioneers welcome!* + +## What? + +LSPServiceKit helps Swift clients use [LSPService](https://github.com/codeface-io/LSPService). ## Context @@ -14,4 +18,10 @@ Here is the internal architecture (composition and essential dependencies) of th ![](Documentation/architecture.png) -The above image was generated with the [Codeface.io](https://www.codeface.io) app. \ No newline at end of file +The above image was generated with the [Codeface](https://www.codeface.io) app. + +## Development Status + +From version/tag 0.1.0 on, LSPServiceKit adheres to [semantic versioning](https://semver.org). So until it has reached 1.0.0, its API may still break frequently, but this will be expressed in version bumps. + +LSPServiceKit is already being used in production, but [Codeface](https://codeface.io) is still its primary client. LSPServiceKit will move to version 1.0.0 as soon as its basic practicality and conceptual soundness have been validated by serving multiple real-world clients. \ No newline at end of file