aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOnur Gündüz <ogunduz@gmail.com>2026-10-07 03:28:42 +0200
committerOnur Gündüz <ogunduz@gmail.com>2026-10-07 03:28:42 +0200
commitd9f54423789fe7b6969140ca4764a8b07d1425d4 (patch)
treeebba4078c33c521c80fa1f868d6ff21452a82150
parentf2febd31df88b281272f43775b6b59ec857b17f9 (diff)
downloadmp4-d9f54423789fe7b6969140ca4764a8b07d1425d4.tar.gz
mp4-d9f54423789fe7b6969140ca4764a8b07d1425d4.zip
docs: update README files
-rw-r--r--README.md8
-rw-r--r--cmd/mp4dump/README.md4
-rw-r--r--cmd/mp4probe/README.md4
-rw-r--r--cmd/mp4remux/README.md9
4 files changed, 20 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7d01a9a..4f22ae1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,12 @@
# mp4
-ISO Base Media File Format (ISOBMFF).
+Read and write ISO Base Media File Format (ISOBMFF) boxes, with support for MP4 track parsing, clipping, and fragmentation.
+
+## Install
+
+```sh
+go get git.onurgunduz.com/mp4
+```
## Usage
diff --git a/cmd/mp4dump/README.md b/cmd/mp4dump/README.md
index 4726062..0e1b273 100644
--- a/cmd/mp4dump/README.md
+++ b/cmd/mp4dump/README.md
@@ -5,11 +5,11 @@
**Example:**
```sh
-mp4dump example.mp4 | indentree
+mp4dump file.mp4
```
You can also output in JSON format:
```sh
-mp4dump --format=json example.mp4
+mp4dump --format=json file.mp4
```
diff --git a/cmd/mp4probe/README.md b/cmd/mp4probe/README.md
index 7c41fdf..18c748f 100644
--- a/cmd/mp4probe/README.md
+++ b/cmd/mp4probe/README.md
@@ -4,8 +4,8 @@ Command `mp4probe` gathers information about tracks and keyframe distribution fr
## Usage
-```
-mp4probe <file.mp4>
+```sh
+mp4probe file.mp4
```
Sample output:
diff --git a/cmd/mp4remux/README.md b/cmd/mp4remux/README.md
new file mode 100644
index 0000000..73bbbe3
--- /dev/null
+++ b/cmd/mp4remux/README.md
@@ -0,0 +1,9 @@
+# mp4remux
+
+Command mp4remux converts MP4 files to fragmented MP4 streams.
+
+## Usage
+
+```sh
+mp4remux input.mp4 -out output.mp4 [-start 0] [-end 0]
+```