From 0a6edad0433d7710338efb13e796035113643772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 7 Jan 2023 12:50:25 +0100 Subject: [PATCH] docs: Warn that Spine is experimental, but the rest is reaching stability --- README.md | 5 +---- spine/README.md | 3 +++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7d7a2df..e6a2c11 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,13 @@ In particular, Pedestal focuses on fullstack development. The rendered documentation for the latest released version is [available here](https://opensavvy.gitlab.io/pedestal/documentation/). The release notes and changelogs are [available here](https://gitlab.com/opensavvy/pedestal/-/releases) or as Git tags. -> This project is currently in beta status. -> We already use it in production, but the API surface is still subject to changes. - This project contains the following modules: - [Pedestal Logger](logger/README.md) is a simple logger implementation for multiplatform projects. - [Pedestal State](state/README.md) is a state management library based on KotlinX.Coroutines and Arrow to represent values that change over time, domain failures, and progression of long-running tasks. - [Pedestal Cache](cache/README.md) is a collection of cache implementations for Pedestal State which helps with reducing network traffic on the entire stack. - [Pedestal Backbone](backbone/README.md) helps with exposing multiple implementations of the same API transparently, facilitating architectural modifications with automatic caching and state management for performant reactive applications. -- [Pedestal Spine](spine/README.md) declares typesafe Kotlin API endpoints that can be easily used from any web server or client. +- [Pedestal Spine](spine/README.md) (experimental) declares typesafe Kotlin API endpoints that can be easily used from any web server or client. Pedestal focuses heavily on Kotlin and depends on some KotlinX libraries (e.g. Coroutines). Apart from that, Pedestal tries to be as agnostic of the technology as possible: for example, Spine APIs can be implemented with any web client or server framework (the Ktor implementation is available out of the box). diff --git a/spine/README.md b/spine/README.md index d44195a..b19c3ca 100644 --- a/spine/README.md +++ b/spine/README.md @@ -1,3 +1,6 @@ # Pedestal Spine +> Pedestal Spine is currently experimental. +> The APIs may change without warning. + Pedestal Spine is a framework allowing the declaration of fullstack Kotlin APIs and data validation in common code, which can later be used to call endpoints on the client-side or implement them on the server-side with type safety. -- 2.51.2