... | ... |
@@ -5,6 +5,20 @@ Web server and client code to [POST][] camera frames. |
5 | 5 |
[`web-post-camera`]: https://git.rcrnstn.net/rcrnstn/web-post-camera |
6 | 6 |
[POST]: https://en.wikipedia.org/wiki/POST_(HTTP) |
7 | 7 |
|
8 |
+## Usage |
|
9 |
+ |
|
10 |
+To generate a self-signed certificate and start the server on the default port |
|
11 |
+and interface, run `make`. |
|
12 |
+ |
|
13 |
+To only generate the certificate, run `make cert.pem`. |
|
14 |
+ |
|
15 |
+To start the server, run `./serve.py [port [host]]`. |
|
16 |
+ |
|
17 |
+The defaults are: |
|
18 |
+ |
|
19 |
+- `port`: `8000` |
|
20 |
+- `host`: `""` (bind to all interfaces) |
|
21 |
+ |
|
8 | 22 |
## License |
9 | 23 |
|
10 | 24 |
Licensed under the [ISC License][] unless otherwise noted, see the |
... | ... |
@@ -4,3 +4,11 @@ Web server and client code to [POST][] camera frames. |
4 | 4 |
|
5 | 5 |
[`web-post-camera`]: https://git.rcrnstn.net/rcrnstn/web-post-camera |
6 | 6 |
[POST]: https://en.wikipedia.org/wiki/POST_(HTTP) |
7 |
+ |
|
8 |
+## License |
|
9 |
+ |
|
10 |
+Licensed under the [ISC License][] unless otherwise noted, see the |
|
11 |
+[`LICENSE`][] file. |
|
12 |
+ |
|
13 |
+[ISC License]: https://choosealicense.com/licenses/isc |
|
14 |
+[`LICENSE`]: LICENSE |