From 63318b44f2bcebd5bae6bf85cadb753b2705aad0 Mon Sep 17 00:00:00 2001 From: Daniel Holden Date: Fri, 14 Apr 2023 12:53:54 +1000 Subject: [PATCH] Add a link to 'Basics to initialising and consuming the library' --- docs/frontend_utilisation_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/frontend_utilisation_guide.md b/docs/frontend_utilisation_guide.md index 769bd011..3c02e50c 100644 --- a/docs/frontend_utilisation_guide.md +++ b/docs/frontend_utilisation_guide.md @@ -164,7 +164,7 @@ document.body.onload = function () { ### Customising the WebSocket connection #### Using setTextSetting within Config to inject a custom WebSocket -When serving the Scalable Pixel Streaming Frontend it will build a default WebSocket address to connect to based on the address of the current window of the webpage. If the WebSocket address matches what is created by default then no further steps are required. Users can override the default by using the `setTextSetting` method on our `config` instance. See the section: Basics to initialising and consuming the library (link) steps 3 and 6. +When serving the Scalable Pixel Streaming Frontend it will build a default WebSocket address to connect to based on the address of the current window of the webpage. If the WebSocket address matches what is created by default then no further steps are required. Users can override the default by using the `setTextSetting` method on our `config` instance. See the section: [Basics to initialising and consuming the library](frontend_utilisation_guide.md#basics-to-initialising-and-consuming-the-library) steps 3 and 6. #### The .env file for the TypeScript example In the TypeScript example there is a `.env.example` file. inside this file there is a line called `WEBSOCKET_URL` containing a filler URL. This file can be used to hard code a WebSocket address that can be consumed by the example as shown above. This example is able to work with the help of the [dotenv NPM package](https://www.npmjs.com/package/dotenv) in the `webpack.common.js` file in the TypeScript example. To implement this example follow these steps: 1) Rename the `.env.example` to `.env`