Skip to content

Commit 2949449

Browse files
committed
update readme
1 parent 3d6aad3 commit 2949449

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ bundle only the utility functions by importing from `'plugin-directory/dist/util
2626

2727
You can reconstruct the `pluginMap` using the `generatePluginMap` utility function.
2828

29+
### A hybrid approach
30+
31+
You may import the `plugins` array from the dynamically updated file at
32+
[`https://source-academy.github.io/plugin-directory/index.js`](https://source-academy.github.io/plugin-directory/index.js).
33+
34+
Marking this file as an external dependency in your build tool will cause it to
35+
be imported at run time. You may also wish to map this file to a local copy
36+
for development builds.
37+
2938
## Plugin definitions
3039

3140
Plugin definitions should follow the `IPluginDefinition` interface.
@@ -48,4 +57,4 @@ You may test any changes (e.g. adding your new language) locally by running `yar
4857
This starts a development server and compiles the directory in watch mode (recompiling on any changes).
4958

5059
The directory will be available at [`http://localhost:8126/directory.json`](http://localhost:8126/directory.json).
51-
On the Source Academy frontend, set the feature flag `plugindir.url` to point to this location.
60+
On the Source Academy frontend, set the feature flag `directory.plugin.url` to point to this location.

0 commit comments

Comments
 (0)