Status links #555

CHANGELOG.md

@@ -3,6 +3,7 @@
 List of changes for this repo, including `atomic-cli`, `atomic-server` and `atomic-lib`.
 By far most changes relate to `atomic-server`, so if not specified, assume the changes are relevant only for the server.
 Changes to JS assets are not included here, but in [`atomic-data-browser`'s CHANGELOG](https://github.com/atomicdata-dev/atomic-data-browser/blob/main/CHANGELOG.md).
+See [STATUS.md](server/STATUS.md) to learn more about which features will remain stable.
 
 ## UNRELEASED
 

README.md

@@ -11,7 +11,8 @@ This repo consists of three components: A library, a server and a CLI.**
 
 [![crates.io](https://img.shields.io/crates/v/atomic-server)](https://crates.io/crates/atomic-server)
 
-_Status: Beta. [Breaking changes](CHANGELOG.md) are expected until 1.0._
+_Status: Beta. [Status](server/STATUS.md) specifies which features are stable. [Breaking changes](CHANGELOG.md) are expected until 1.0._
+
 
 **Atomic-server is a graph database server for storing and sharing [Atomic Data](https://docs.atomicdata.dev/).
 Demo on [atomicdata.dev](https://atomicdata.dev)**

server/STATUS.md

@@ -1,25 +1,26 @@
 # Atomic-Server status & Feature stability
 
-If you're contemplating to use Atomic-Server in a production environment, you'll want to know to what extent you could rely on this project. 
+If you're contemplating to use Atomic-Server in a production environment, you'll want to know to what extent you could rely on this project.
 Some features are prone to change, whilst others are already fully working as intended.
+See [Changelog](../CHANGELOG.md) for a historical overview of (breaking) changes.
 This document describes the current status of Atomic-Server, and specifically which features are stable, and which are not.
 
 ## Stable
 
-These features are very unlikely to be significantly altered until V1.0. They will also not be dropped. 
+These features are very unlikely to be significantly altered until V1.0. They will also not be dropped.
 
 - HTTP Resource fetching.
 - JSON-AD serialization / parsing.
-- TLS / HTTPS setup. 
+- TLS / HTTPS setup.
 - WebSockets. Some features may be added, but for most use cases the current implementation works great.
 - Commits. There may be changes in the signature algorithm or the likes, but I don't expect much changes.
 - Storage + migration system. Upgrading your Atomic-Server should not lead to data loss. Migrations are fully automated.
 
 ## Likely to change
 
-- Endpoint API. Currently only supports GET requests. 
+- Endpoint API. Currently only supports GET requests.
 - Collections / Queries. Relatively stable, but still lacks some important features (like having multiple filters in one Query).
-- Cookie Authentication. 
+- Cookie Authentication.
 - Document editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/2).
 - Table editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/3).
 - URL requirements for new URLS, see [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/556)