From abd47feb26d0d8784afa1f632578251def354389 Mon Sep 17 00:00:00 2001 From: Vesa Karvonen Date: Tue, 8 Aug 2023 22:36:52 +0300 Subject: [PATCH] Logo (#123) Logo for Kcas --- README.md | 10 ++++++++ doc/kcas.svg | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 doc/kcas.svg diff --git a/README.md b/README.md index 2ff4a263..cc53e044 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,14 @@ The API was redesigned in version 0.2.0 — see [API reference for version 0.1.8](https://ocaml-multicore.github.io/kcas/0.1.8/kcas/Kcas/index.html).) +
+ + + # **kcas** — STM based on lock-free MCAS +
+ [**kcas**](https://ocaml-multicore.github.io/kcas/doc/kcas/Kcas/index.html) provides a software transactional memory (STM) implementation based on an atomic [lock-free](https://en.wikipedia.org/wiki/Non-blocking_algorithm#Lock-freedom) @@ -49,6 +55,10 @@ most practical needs. **kcas** is [published on **opam**](https://opam.ocaml.org/packages/kcas/) and is distributed under the [ISC license](LICENSE.md). +[![OCaml-CI Build Status](https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Focaml-multicore%2Fkcas%2Fmain&logo=ocaml&style=flat-square)](https://ci.ocamllabs.io/github/ocaml-multicore/kcas) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ocaml-multicore/kcas?style=flat-square&color=09aa89)](https://github.com/ocaml-multicore/kcas/releases/latest) +[![docs](https://img.shields.io/badge/doc-online-blue.svg?style=flat-square)](https://ocaml-multicore.github.io/kcas/doc/) + ## Contents - [A quick tour](#a-quick-tour) diff --git a/doc/kcas.svg b/doc/kcas.svg new file mode 100644 index 00000000..82dde500 --- /dev/null +++ b/doc/kcas.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + +