Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d8a5d48

Browse files
committedOct 4, 2022
Document development status and start semantic versioning
1 parent aa44e34 commit d8a5d48

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed
 

‎README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# LSPServiceKit
22

3-
A package that helps Swift clients use [LSPService](https://github.com/codeface-io/LSPService).
3+
👩🏻‍🚀 *This project [is still a tad experimental](#development-status). Contributors and pioneers welcome!*
4+
5+
## What?
6+
7+
LSPServiceKit helps Swift clients use [LSPService](https://github.com/codeface-io/LSPService).
48

59
## Context
610

@@ -14,4 +18,10 @@ Here is the internal architecture (composition and essential dependencies) of th
1418

1519
![](Documentation/architecture.png)
1620

17-
The above image was generated with the [Codeface.io](https://www.codeface.io) app.
21+
The above image was generated with the [Codeface](https://www.codeface.io) app.
22+
23+
## Development Status
24+
25+
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.
26+
27+
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 commit comments

Comments
 (0)
Please sign in to comment.