From a3a55dd1958f0e7df6add468ac3c8fd08fcd6aaa Mon Sep 17 00:00:00 2001 From: Lorenz Schmidt Date: Fri, 5 Jun 2020 18:03:01 +0200 Subject: [PATCH] Indicate unstable API in README and mdbook (#781) --- README.md | 2 +- docs/src/contributing_websocket_http_api.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c4f6bfa90c..09b2540f0a8 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The overall goal is to create an easily self-hostable, decentralized alternative Each lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing. -*Note: Federation is still in active development* +*Note: Federation is still in active development and the WebSocket, as well as, HTTP API are currently unstable* ### Why's it called Lemmy? diff --git a/docs/src/contributing_websocket_http_api.md b/docs/src/contributing_websocket_http_api.md index f228f94e02f..567f674cd9e 100644 --- a/docs/src/contributing_websocket_http_api.md +++ b/docs/src/contributing_websocket_http_api.md @@ -1,6 +1,6 @@ # Lemmy API -*Note: this may lag behind the actual API endpoints [here](../server/src/api).* +*Note: this may lag behind the actual API endpoints [here](../server/src/api). The API should be considered unstable and may change any time.*