Update fromBinary docs

mdingena · Sep 13, 2023 · 963869b · 963869b
1 parent 628b48f
commit 963869b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/Entity.md b/docs/Entity.md
@@ -96,7 +96,7 @@ Reads the binary string data and returns an instantiated entity.
 ```ts
 import { Entity } from 'att-string-transcoder';
 
-const torchFireEntity = Entity.fromBinary<'Torch'>(myBinaryString);
+const torchFireEntity = Entity.fromBinary<'Torch'>(binaryReader, { key, hash });
 ```
 
 ## Properties

diff --git a/src/Entity.ts b/src/Entity.ts
@@ -171,7 +171,7 @@ export class Entity<TPrefabName extends ATTPrefabName> {
    * @example
    * import { Entity } from 'att-string-transcoder';
    *
-   * const torchFireEntity = Entity.fromBinary<'Torch'>(myBinaryString);
+   * const torchFireEntity = Entity.fromBinary<'Torch'>(binaryReader, { key, hash });
    */
   static fromBinary<TPrefabName extends ATTPrefabName>(
     reader: BinaryReader,