From f4ebdf85dddc0ff2ceea14dcda08f2c9025444a3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= <sporiff@funkwhale.audio>
Date: Thu, 29 Sep 2022 13:41:56 +0200
Subject: [PATCH] Add README

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f59abf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Funkwhale API client
+
+A [Typescript](https://www.typescriptlang.org/) client library for accessing the Funkwhale API.
+
+> **Note**: This client is under active development and is not considered production-ready.
+
+This library is intended for use in the Funkwhale frontend and any projects that rely on Funkwhale's API endpoints. Check out the [docs](https://dev.funkwhale.audio/funkwhale/api-client-typescript/-/blob/main/docs/index.md) for usage information.
+
+## Contribute to development
+
+The Funkwhale API client is generated from the Funkwhale OpenAPI schema. If you notice an issue with the API itself, consider contributing to [Funkwhale](https://dev.funkwhale.audio/funkwhale/funkwhale).
-- 
GitLab