patrick/Vosklet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
msqr1
2024-09-01 12:31:03 -07:00
parent 3f50beaee2
commit f2584323cb
5 changed files with 36 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Examples/README.md
View File

@@ -1 +1,3 @@
**Note: Examples in this folder uses its own *Vosklet.js* because I can't set the Response headers for my model for browsers to decompress correctly. Instead, I used DecompressionStream to decompress manually, so this *Vosklet.js* only works for the examples. In production, please use the top-level Vosklet.js instead.**
#### The file Vosklet.js in this folder, used by the examples and the outer [README.md](../README.md), has been set to decompress manually using ```DecompressionStream``` because I can't set a third-party (Github's) server response header. You can utilize this if you run into the same situation. Otherwise, please use the outer Vosklet.js instead.
#### The motivation is that it will work right away when put into a HTML file. You can just make a local copy and everything out quickly