From 51adfc85cd03bd24fbf4b535f7a6c5b220dbc4db Mon Sep 17 00:00:00 2001 From: wukko Date: Sun, 20 Oct 2024 17:20:38 +0600 Subject: [PATCH] api: update readme --- api/README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/api/README.md b/api/README.md index 5c281246..05664321 100644 --- a/api/README.md +++ b/api/README.md @@ -11,12 +11,14 @@ as long as you: ## running your own instance if you want to run your own instance for whatever purpose, [follow this guide](/docs/run-an-instance.md). -it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes. +we recommend to use docker compose unless you intend to run cobalt for developing/debugging purposes. ## accessing the api -currently, there is no publicly accessible main api. we plan on providing a public api for -cobalt 10 in some form in the future. we recommend deploying your own instance if you wish -to use the latest api. you can access [the documentation](/docs/api.md) for it here. +there is currently no publicly available pre-hosted api. +we recommend [deploying your own instance](/docs/run-an-instance.md) if you wish to use the cobalt api. -if you are looking for the documentation for the old (7.x) api, you can find -it [here](https://github.com/imputnet/cobalt/blob/7/docs/api.md) \ No newline at end of file +you can read [the api documentation here](/docs/api.md). + +> [!WARNING] +> the v7 public api (/api/json) will be shut down on **november 11th, 2024**. +> you can access documentation for it [here](https://github.com/imputnet/cobalt/blob/7/docs/api.md).