Skip to content

Commit

Permalink
Document development status and start semantic versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
flowtoolz committed Oct 4, 2022
1 parent aa44e34 commit d8a5d48
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
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.

0 comments on commit d8a5d48

Please sign in to comment.