Skip to content

Commit c45b020

Browse files
committed
Document development status and start semantic versioning
1 parent 0b90f82 commit c45b020

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# SwiftNodes
22

3-
A Swift package providing a `Graph` data structure and various graph algorithms.
3+
👩🏻‍🚀 *This project [is still a tad experimental](#development-status). Contributors and pioneers welcome!*
44

5-
It serves as critical infrastructure for [Codeface.io](https://www.codeface.io).
5+
## What?
6+
7+
SwiftNodes provides a `Graph` data structure and various graph algorithms.
8+
9+
It serves as critical infrastructure for the [Codeface](https://www.codeface.io) app.
610

711
## Architecture
812

9-
Here is the internal composition with its essential dependencies:
13+
Here is the internal architecture (composition and essential dependencies):
1014

1115
![](Documentation/architecture.png)
1216

13-
The above image was created with [Codeface.io](https://www.codeface.io).
17+
The above image was created with the [Codeface](https://www.codeface.io) app.
18+
19+
## Development Status
20+
21+
From version/tag 0.1.0 on, SwiftNodes 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.
22+
23+
SwiftNodes is already being used in production, but [Codeface](https://codeface.io) is still its primary client. SwiftNodes 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)