From ea282fd8806c37b8c0e177a7af375c7fe1dc5847 Mon Sep 17 00:00:00 2001 From: tecc Date: Mon, 8 May 2023 01:25:43 +0200 Subject: [PATCH] change: Add notice to gipc about instability --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index a5273e0..6eafd4a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ **General Interprocess Communication** (or _gipc_, pronounced like gypsy /ʤɪ́psɪ/) is a library that abstracts away common things in interprocess communication to speed up development and reduce errors. +> NOTE: +> +> gipc is not entirely stable yet - there are still a few wrinkles to iron out. +> Whilst it is production-ready, the API may be subject to change. + ## Usage To get a sense of how to use gipc, please read the [examples](./examples); these show roughly how the code would look in an application, alongside explanations of why everything happens in the order that it does.