From a9e21891c5f580725143ba6602d223083e0c6fe6 Mon Sep 17 00:00:00 2001
From: Neur0toxine <pashok9825@gmail.com>
Date: Sat, 25 May 2024 21:50:34 +0300
Subject: [PATCH] update readme

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bacf750..2ce9f37 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # atranscoder-rpc
 
-Audio transcoder with simple HTTP API. Work in progress, nothing is implemented yet...
\ No newline at end of file
+Audio transcoder with simple HTTP API. Work in progress.
+
+# What works
+
+Transcoding:
+1. `cargo run`
+2. Upload file for transcoding:
+```bash
+curl --location 'http://localhost:8090/enqueue' \
+    --form 'file=@"/home/user/Music/test.mp3"' \
+    --form 'format="adts"' \
+    --form 'codec="aac"' \
+    --form 'bitRate="64000"' \
+    --form 'maxBitRate="64000"' \
+    --form 'sampleRate="8000"' \
+    --form 'channelLayout="mono"' \
+    --form 'uploadUrl="http://127.0.0.1:8909/upload"'
+```
+3. You will receive JSON response with job ID. The transcoding result will be saved into `/tmp/{job_id}.out.atranscoder`
+
+# Roadmap
+- [ ] Implement acceptable error handling.
+- [ ] Restart threads in case of panic.
+- [ ] Remove old conversion results and input files every Nth hours.
+- [ ] Remove input file after transcoding it.
+- [ ] Implement file upload to `uploadUrl` (if `Content-Type: application/json` then conversion was not successful and body contains an error info).
+- [ ] Remove transcoding result after uploading it to the `uploadUrl`.
+- [ ] (Optional) Make `uploadUrl` optional and allow the client to download the file on-demand.
+- [ ] Docker image for `amd64` and `aarch64`.
+- [ ] Tests!
\ No newline at end of file