From 5b37d04e230bb78bf2d166f3b9848e0166f351ab Mon Sep 17 00:00:00 2001 From: Ivan “CLOVIS” Canet Date: Sat, 02 Nov 2024 18:08:56 +0000 Subject: [PATCH] docs: Add versioned documentation in module headers --- backbone/README.md | 3 ++- cache-blocking/README.jvm.md | 4 ++-- cache/README.md | 4 ++-- logger/README.md | 4 ++-- progress-coroutines/README.md | 4 ++-- progress/README.md | 4 ++-- state-arrow/README.md | 4 ++-- state-coroutines/README.md | 4 ++-- state/README.md | 4 ++-- weak/README.md | 4 ++-- 10 file(s) changed, 20 insertion(s)(+), 19 deletion(s)(-) diff --git a/backbone/README.md b/backbone/README.md --- a/backbone/README.md +++ b/backbone/README.md @@ -3,8 +3,9 @@ Lightweight pattern to integrate reactive caching in all layers of a multiplatform application. + + - ## The problem diff --git a/cache-blocking/README.jvm.md b/cache-blocking/README.jvm.md --- a/cache-blocking/README.jvm.md +++ b/cache-blocking/README.jvm.md @@ -3,8 +3,8 @@ Blocking wrappers for Pedestal Cache, for contexts in which coroutines are not available in. - - + + # Package opensavvy.cache.blocking diff --git a/cache/README.md b/cache/README.md --- a/cache/README.md +++ b/cache/README.md @@ -3,8 +3,8 @@ Pedestal Cache is a collection of in-process cache algorithms. - - + + Caching is a powerful technique which allows to dramatically reduce I/O requests, making applications faster and more responsive. For more information on our recommendations for cache-aware software architecture, see the Backbone module. diff --git a/logger/README.md b/logger/README.md --- a/logger/README.md +++ b/logger/README.md @@ -3,8 +3,8 @@ Simple multiplatform [Logger][opensavvy.logger.Logger] interface that delegates to the logging facilities of the underlying platform. - - + + Example usage: diff --git a/progress-coroutines/README.md b/progress-coroutines/README.md --- a/progress-coroutines/README.md +++ b/progress-coroutines/README.md @@ -3,8 +3,8 @@ Compatibility layer for `progress` and KotlinX.coroutines. - - + + Using the utility functions declared in this project, it is possible to report progress events from any coroutine without changing its signature. Simply call the [report][opensavvy.progress.coroutines.report] function: diff --git a/progress/README.md b/progress/README.md --- a/progress/README.md +++ b/progress/README.md @@ -3,8 +3,8 @@ Lingua franca to represent the state of an unfinished task. - - + + It is often recommended to communicate the progress of any task that doesn't finish instantly to the user. However, this is often forgotten and implemented as a last-minute addition. diff --git a/state-arrow/README.md b/state-arrow/README.md --- a/state-arrow/README.md +++ b/state-arrow/README.md @@ -3,7 +3,7 @@ Compatibility layer for `state` and [Arrow Core](https://arrow-kt.io/learn/typed-errors/working-with-typed-errors/). - - + + All functionality from this module has been migrated into the `state` module. Please delete this module from your dependencies, it will be removed in Pedestal 3.0. diff --git a/state-coroutines/README.md b/state-coroutines/README.md --- a/state-coroutines/README.md +++ b/state-coroutines/README.md @@ -3,5 +3,5 @@ Compatibility layer for `state` and KotlinX.Coroutines. - - + + diff --git a/state/README.md b/state/README.md --- a/state/README.md +++ b/state/README.md @@ -3,8 +3,8 @@ Small library for value-based outcome representation. - - + + Using `state`, it is possible to model a successful operation, a failed operation, as well as the intermediate progress states of an ongoing operation (using `progress`). diff --git a/weak/README.md b/weak/README.md --- a/weak/README.md +++ b/weak/README.md @@ -3,8 +3,8 @@ Weak references and maps for Kotlin Multiplatform. - - + + ## Introduction -- tangled.sh