]> Untitled Git - lemmy.git/commitdiff
Indicate unstable API in README and mdbook (#781)
authorLorenz Schmidt <bytesnake@mailbox.org>
Fri, 5 Jun 2020 16:03:01 +0000 (18:03 +0200)
committerGitHub <noreply@github.com>
Fri, 5 Jun 2020 16:03:01 +0000 (12:03 -0400)
README.md
docs/src/contributing_websocket_http_api.md

index 9c4f6bfa90ca561c98121e4791bc3f67fa2a1ad4..09b2540f0a8e9eba4488b31b9db377db076dfb85 100644 (file)
--- 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?
 
index f228f94e02fcda379bb661eb5f0e2d2457b28b43..567f674cd9eb6a8277155e30e855f6c995d316cc 100644 (file)
@@ -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.*
 
 <!-- toc -->