From e496ccb45afb3c7a89c374126f17cec441eca96b Mon Sep 17 00:00:00 2001 From: Cadence Ember Date: Thu, 12 Aug 2021 18:28:38 +1200 Subject: [PATCH] Update blurb in README to reflect current state --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 90aee82..dcf86d4 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,15 @@ - [Todo tracker][todo] for listing problems and feature requests - [Chatroom on Matrix][matrix] -A Python web project that mirrors the Invidious API, passing all calls -directly to youtube-dl and reformatting the response to be compatible. +NewLeaf is a YouTube data extractor, compatible with the Invidious API. -## Status +NewLeaf has no frontend. It is intended to be used in combination with +a frontend like [CloudTube](https://git.sr.ht/~cadence/cloudtube). + +NewLeaf uses [yt-dlp](https://github.com/yt-dlp/yt-dlp) to assist with +data extraction, but also does some extraction itself. + +## API status [→ See the documentation.](https://git.sr.ht/~cadence/tube-docs/tree/main/item/docs/newleaf/API.md)