Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 696 B
Newer Older
  • Learn to ignore specific revisions
    • Ciarán Ainsworth's avatar
    Add README
    Ciarán Ainsworth committed
    1 2 3 4 5 6 7 8 9 10 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).