Skip to content

Commit

Permalink
chore(docs): update docs with modern compiler usage
Browse files Browse the repository at this point in the history
  • Loading branch information
FreddieGilbraith committed Jul 3, 2024
1 parent f066738 commit fca72e4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ var result = EvaluateFunction('my_ink_function', ['arg1', 'arg2'], true);
As this library is a port from C#, it requires a less standard way to assign the `Story` class, including all other classes, to a variable:

```ts
import { Story, Compiler } from 'inkjs';
import { Story, Compiler } from 'inkjs/full';

let story: InstanceType<typeof Story>;
let compiler: InstanceType<typeof Compiler>;
Expand All @@ -149,7 +149,7 @@ let compiler: InstanceType<typeof Compiler>;
Further, to minimize the verbose assignment, you can also create aliases in your project:

```ts
import { Story, Compiler } from 'inkjs';
import { Story, Compiler } from 'inkjs/full';

export type InkStory = InstanceType<typeof Story>;
export type InkCompiler= InstanceType<typeof Compiler>;
Expand Down

0 comments on commit fca72e4

Please sign in to comment.