Update Readme

This commit is contained in:
Mev Lyshkin 2021-04-21 18:40:12 +02:00
parent 5ad27dc4eb
commit 1b5d4e6904
1 changed files with 19 additions and 1 deletions

View File

@ -4,7 +4,23 @@ Simple server made with hosting locally webgl games in mind.
It makes testing Unity webgl games easy, even allows connecting with different domains(less CORS issues during tests). It makes testing Unity webgl games easy, even allows connecting with different domains(less CORS issues during tests).
## It is NOT meant to use in production environment > **ACHTUNG!**
>
> **WARNING!**
>
> It is **NOT** meant to use in production environment
## Installation
For now it is required to have cargo and rust installed:
```bash
git clone https://github.com/Leinnan/lwa_simple_server.git
cd lwa_simple_server
cargo install --path .
```
## Usage
To start run it in folder that should be root folder of hosted site: To start run it in folder that should be root folder of hosted site:
@ -23,6 +39,8 @@ certificate_chain_file = 'cert.pem'
use_ssl = false use_ssl = false
``` ```
## SSL
If you would like to use OpenSSL create key with command below and pass paths to generated files in config above in order to use it: If you would like to use OpenSSL create key with command below and pass paths to generated files in config above in order to use it:
```bash ```bash