diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..5f59abfddbaae4c1c0199cce66fdb2bf1019cb0a --- /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).