chore(cors): document cors feature

LeoBorai · LeoBorai · commit f0918816a18a · 2021-05-09T23:42:12.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,13 @@
 
 #### Features
 
+* A `Middleware` is implemented bringing the capabilities to act on
+`hyper::Request<Body>` before executing the main handler (a.k.a File Explorer)
+and to act on the `hyper::Response<Body>` after executing the main handler.
+This helps implementing future features which relies on acting on different
+stages of the HTTP/S request lifecycle such as logging, authentication, caching
+and so on.
+
 * Support for Cross-Origin Resource Sharing
 
 * Using the `--cors` flag when running the HTTP Server will now provide a
@@ -31,11 +38,14 @@ request_method = "GET"
 #### Improvements
 
 * Codebase refactor for `server` module, introducing middleware support for
-services to programatically build a server instance from the provided `Config`
+services to programmatically build a server instance from the provided `Config`
 
 * Replace `full` feature flags on `tokio` and `hyper` with sepecific features,
 to reduce crate load on compile time. This improve build times and crate size.
 
+* Improved tests coverage by implementing tests for CLI arguments and config
+file parsing
+
 #### Fixes
 
 * Fix issue where the `root_dir` is taken _as is_ from the CLI
@@ -46,6 +56,9 @@ directory for the `FileExplorer`
 and uses the current working directory as default `root_dir` as is
 done for CLI
 
+* Fix issue where errors returned by any internal service are not
+logged to stderr
+
 <a name="v0.2.2"></a>
 ## v0.2.2 (2021-04-22)
 
diff --git a/README.md b/README.md
@@ -46,6 +46,7 @@ http-server --help
 
 Name | Short | Long | Description
 --- | --- | --- | ---
+Cross-Origin Resource Sharing | N/A | `--cors` | Enable Cross-Origin Resource Sharing allowing any origin
 Help | N/A | `--help` | Prints help information
 Version | `-V` | `--version` | Prints version information
 Verbose | `-v` | `--verbose` | Prints output to console
@@ -73,7 +74,7 @@ TLS Key Algorithm | N/A | `--tls-key-algorithm` | Algorithm used to generate cer
 The following are some relevant details on features supported by this HTTP Server
 solution that may be of the interest of the user.
 
-### TLS Reference
+### TLS (HTTPS)
 
 The TLS solution supported for this HTTP Server is built with [rustls](https://github.com/ctz/rustls)
 crate along with [hyper-rustls](https://github.com/ctz/hyper-rustls).
@@ -92,6 +93,34 @@ Run `http-server` as follows:
 http-server --tls --tls-cert <PATH TO YOUR CERTIFICATE> --tls-key <PATH TO YOUR KEY> --tls-key-algorithm pkcs8
 ```
 
+### Cross-Origin Resource Sharing (CORS)
+
+This HTTP Server brings support to CORS headers _out of the box_.
+Based on the headers you want to provide to your HTTP Responses, 2
+different methods for CORS configuration are available.
+
+By providing the `--cors` option to the `http-server`, CORS headers
+will be appended to every HTTP Response, allowing any origin.
+
+For more complex configurations, like specifying an origin, a set of allowed
+HTTP methods and more, you should specify the configuration via the configuration
+TOML file.
+
+The following example shows all the options available, these options are
+mapped to the server configuration during initialization.
+
+```toml
+[cors]
+allow_credentials = false
+allow_headers = ["content-type", "authorization", "content-length"]
+allow_methods = ["GET", "PATCH", "POST", "PUT", "DELETE"]
+allow_origin = "example.com"
+expose_headers = ["*", "authorization"]
+max_age = 600
+request_headers = ["x-app-version"]
+request_method = "GET"
+```
+
 ## Release
 
 In order to create a release you must push a Git tag as follows
