aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md33
-rw-r--r--box.go4
2 files changed, 2 insertions, 35 deletions
diff --git a/README.md b/README.md
index 75982be..237c05e 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,6 @@
ISOBMFF/MP4 container library with fragmented MP4 support.
-## Install
-
-```sh
-go get github.com/tetsuo/mp4
-```
-
## Usage
### Reading boxes
@@ -127,30 +121,3 @@ for {
Use `Reader.SetTimeRange` to limit output to a time window, or `Reader.Seek` to
reposition before reading fragments.
-
-## Examples
-
-The [cmd](./cmd) directory contains small programs built on these packages:
-
-- `mp4dump` prints the box structure of a file as text or JSON.
-- `mp4probe` displays track and fragment information.
-- `mp4remux` remuxes a file into fragmented MP4.
-
-## Performance
-
-```
-goos: darwin
-goarch: arm64
-pkg: github.com/tetsuo/mp4
-cpu: Apple M4 Pro
-BenchmarkReaderParse
-BenchmarkReaderParse-12 3547731 317.4 ns/op 58353.33 MB/s 0 B/op 0 allocs/op
-BenchmarkStszIter
-BenchmarkStszIter-12 897819 1230.0 ns/op 2348.81 MB/s 0 B/op 0 allocs/op
-BenchmarkWriterBuild
-BenchmarkWriterBuild-12 15768681 76.26 ns/op 0 B/op 0 allocs/op
-BenchmarkScannerParse
-BenchmarkScannerParse-12 343438 3512.0 ns/op 5274.38 MB/s 0 B/op 0 allocs/op
-PASS
-ok github.com/tetsuo/mp4 5.023s
-```
diff --git a/box.go b/box.go
index 7c4021d..e46e561 100644
--- a/box.go
+++ b/box.go
@@ -1,5 +1,5 @@
-// Package mp4 provides support for the ISO base media file format and
-// fragmented MP4 streams.
+// Package mp4 provides support for reading and writing ISO Base Media File Format
+// (ISOBMFF) files, commonly known as MP4.
package mp4
// BoxType is a 4-byte box type identifier.