Skip to content

Commit e065c48

Browse files
authored
Update README.md with imports
1 parent a50a7c0 commit e065c48

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@ var result = EvaluateFunction('my_ink_function', ['arg1', 'arg2'], true);
140140
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:
141141

142142
```ts
143-
import { Story, Compiler } from 'inkjs';
143+
import { Story } from 'inkjs';
144+
import { Compiler } from 'inkjs/full'; // Compiler is not provided in the default inkjs package
144145

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

151152
```ts
152-
import { Story, Compiler } from 'inkjs';
153+
import { Story, Compiler } from 'inkjs/full'; // Story is also provided in the "full" subpackage.
153154

154155
export type InkStory = InstanceType<typeof Story>;
155156
export type InkCompiler= InstanceType<typeof Compiler>;

0 commit comments

Comments
 (0)