update readme

finnvoor · Feb 20, 2024 · e5e8366 · e5e8366
1 parent 9b47c15
commit e5e8366
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # Transcoding (WIP)
+It is recommended that you pin to a specific commit at the moment, since there may be breaking changes before an official release.
 
 Example usage. You can also use it without the annex B adaptors if you only need compressed sample buffers, but the annex B adaptors are perfect for sending video over a network.
 ```swift
@@ -7,7 +8,7 @@ let videoEncoderAnnexBAdaptor = VideoEncoderAnnexBAdaptor(
     videoEncoder: videoEncoder
 )
 let videoDecoder = VideoDecoder(config: .init())
-let videoDecoderAnnexBAdaptor = try! VideoDecoderAnnexBAdaptor(
+let videoDecoderAnnexBAdaptor = VideoDecoderAnnexBAdaptor(
     videoDecoder: videoDecoder,
     codec: .hevc
 )

diff --git a/Sources/Transcoding/VideoDecoderAnnexBAdaptor.swift b/Sources/Transcoding/VideoDecoderAnnexBAdaptor.swift
@@ -10,7 +10,7 @@ public final class VideoDecoderAnnexBAdaptor {
     public init(
         videoDecoder: VideoDecoder,
         codec: Codec
-    ) throws {
+    ) {
         self.videoDecoder = videoDecoder
         self.codec = codec
     }