docs: 📝setup minimalistic README

README.md

@@ -1,18 +1,69 @@
+# LibAV WASM
+
+This library can be used to transmux from MKV -> MP4, it could technically do any transmux but i haven't had the need for it, create an issue if you'd like it.
+
+Basic usage
+```ts
+const remuxer = await makeTransmuxer({
+  // the path at which the wasm file is getting served
+  publicPath: new URL('/dist/', new URL(import.meta.url).origin).toString(),
+  // url of the worker file of libavWASM
+  workerUrl: new URL('../build/worker.js', import.meta.url).toString(),
+  // reads are done in 2.5mb chunks
+  bufferSize: 2_500_000,
+  // byte length of the video file
+  length: contentLength,
+  // fetch returning a ReadableStream
+  getStream: async (offset, size) =>
+    fetch(
+      VIDEO_URL,
+      {
+        headers: {
+          Range: `bytes=${offset}-${size ? Math.min(offset + size, contentLength) - 1 : ''}`
+        }
+      }
+    ).then(res => res.body)
+  ,
+  // callback where you'll receive the subtitle chunks
+  subtitle: (title, language, subtitle) => {
+    // console.log('SUBTITLE HEADER', title, language, subtitle)
+  },
+  // callback where you'll receive the attachments
+  attachment: (filename: string, mimetype: string, buffer: ArrayBuffer) => {
+    // console.log('attachment', filename, mimetype, buffer)
+  }
+})
+
+// Returns a chunk that looks like {
+//   isHeader: boolean,
+//   offset: number,
+//   buffer: Uint8Array,
+//   pos: number,
+//   pts: number, // timestamp
+//   duration: number
+// }
+// buffer can be appended to the MediaSource API(MSE API)
+const chunk = await remuxer.read()
+
+// allows you to seek to timestamp and start reading from there
+await remuxer.seek(number)
+
+await remuxer.read()
+```
+
+
+
 ## Intellisense 
 To have C++ autocompletion, put a ffmpeg repo clone folder in the root
 `git clone https://github.com/FFmpeg/FFmpeg` & `git clone https://github.com/emscripten-core/emscripten`
 
 
 
 ## Issues to fix / features to implement
-- cancellable requests
 - Transcoding
 - Decoding + canvas rendering
 - Thumbnail extraction
 
 
-
-
-
 <!-- https://www.ffmpeg.org/doxygen/trunk/remuxing_8c-example.html -->
 <!-- https://github.com/leandromoreira/ffmpeg-libav-tutorial -->