Added README.md to GeniusAPI

2025-08-05 00:51:35 +02:00
parent 4015d37657
commit bbf3c645b0
1 changed files with 16 additions and 0 deletions
--- a/GeniusAPI/README.md
+++ b/GeniusAPI/README.md
@@ -0,0 +1,16 @@
+# Genius API
+
+## Important notes
+### Legal note
+For legal reasons, this tool is for educational purposes only. And Scraping is not allowed by the Genius API Terms of Service. And I do not encourage the use of Scraping websites for any data, and that API endpoints should always be used instead.
+
+## API key required
+This tool requires a Genius API key to work since it fetches song metadata from the Genius API.
+
+The API key shuld be stored in `${DATA_DIR}/geniusapi.json` using the following format:
+```json
+{
+  "client_id": "<your_client_id>",
+  "client_secret": "<your_client_secret>"
+}
+```