diff --git a/README.md b/README.md index fd0526f..cc10d4b 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ which will give you the following in order of confidence: By default, this library will work in Node.js. It uses the `fs` and `path` modules provided by Node.js to read in the `model.json` file and the weights file, `group1-shard1of1.bin`, that are contained in this repo. -You can overwrite that behavior using the first two optional parameters of `ModelOperations`: +You can overwrite that behavior using the optional options bag of `ModelOperations`: ```ts modelJSONFunc?: () => Promise // This must return a JSON.parse() object @@ -89,11 +89,75 @@ weightsFunc?: () => Promise These allow you to overwrite the model loading behavior of this package if you happen to be in a non-traditional environment. For an example of this, check out how [VS Code is doing it](https://github.com/microsoft/vscode/blob/3a1cf8e51e3797a2d9ccb12d207378de364596c4/src/vs/workbench/services/languageDetection/browser/languageDetectionService.ts#L60-L80). -The third parameter is the options bag that has: +Other options: * `minContentSize?: number` - The minimum number of characters in a file to be considered for language detection. Defaults to `20`. * `maxContentSize?: number` - The maximum number of characters *that will be used* in a file to be considered for language detection. Defaults to `100000`. +
+ +Example of use in the browser + + +```html + + + +``` + +
+ ## Local development To build from source, follow these steps: