Skip to content

Commit e813a90

Browse files
author
Leadbetter
committed
updating readme
1 parent 1ea466d commit e813a90

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,19 @@ If you opt to use `npm`, simply replace all mentions of `yarn` below with `npm r
1616

1717
## First time Usage
1818

19-
### [Developer Rig](https://github.com/twitchdev/developer-rig) Usage
19+
### [Developer Rig](https://dev.twitch.tv/docs/extensions/rig/) Usage
2020

2121
If you are using the developer rig and have used this as your basis for your extension, please ignore the below steps- the developer rig has taken care of it for you!
2222

23+
### Please note that HTTPS only works with the Developer Rig version 1.1.4 and above.
24+
25+
If you are using a version below that, please either upgrade or disable HTTP. To do so:
26+
27+
1. Go into `/webpack.config.js`
28+
2. Update `config.devServer.https = true` to `config.devServer.https = false`
29+
3. On the [Twitch Developer Console](https://dev.twitch.tv/console), make sure to update the Asset Hosting path for your extension to use http instead.
30+
4. Refresh your manifest in the Developer Rig and recreate your views.
31+
2332
### Local Development
2433

2534
If you're wanting to develop this locally, use the below instructions.
@@ -34,10 +43,9 @@ Next, do the following:
3443

3544
1. Change directories into the cloned folder.
3645
2. Run `yarn install` to install all prerequisite packages needed to run the template.
37-
3. Run `yarn cert` to generate the needed certificates. This allows the server to be run over HTTPS vs. HTTP.
38-
4. Run `yarn start` to run the sample. If everything works, you should be be able to go to the developer rig, create a panel view, and see `Hello world!`
46+
3. Run `yarn start` to run the sample. If everything works, you should be be able to go to the developer rig, create a panel view, and see `Hello world!`
3947

40-
## Usage
48+
## Building Production Files
4149

4250
To build your finalized React JS files, simply run `yarn build` to build the various webpacked files. These files will use code splitting to only load in the libraries needed for that view, while still allowing you to reuse components.
4351

@@ -78,14 +86,6 @@ For a small demonstration of the class, see the App compoonent.
7886

7987
The file structure in the template is laid out with the following:
8088

81-
### bin
82-
83-
The `/bin` folder holds the cert generation script.
84-
85-
### conf
86-
87-
The `/conf` folder holds the generated certs after the cert generation script runs. If this folder gets emptied, rerun `yarn cert`.
88-
8989
### dist
9090

9191
`/dist` holds the final JS files after building. You can simply zip up the contents of the folder to upload to Twitch to move to Hosted Test.

0 commit comments

Comments
 (0)