README rework (#166)

* Reworking docs

* Move more stuff to docs/

* Integrate README updates

* Pass over README

* Update timeout doc

* Add timeout param for functions

* Further doc cleanup

* Ensure consistent linting libs

* Enforce prettier version

* Revert changes

* Fix version of prettier in tests

* Linting

* Review comments

* Subheadings

* Linting

Author: Shillaker

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
-      - run: npx prettier --check .
+      - run: npx prettier@2.8.8 --check .
 
   test:
     needs: lint

README.md

@@ -0,0 +1,35 @@
+# Managing containers
+
+To manage your containers, you can define them in the `custom.containers` field in your `serverless.yml` configuration file.
+
+Each container must specify the relative path to its directory, which contains the Dockerfile, and all files related to the application:
+
+```yml
+custom:
+  containers:
+    mycontainer:
+      directory: my-container-directory
+      env:
+        MY_VARIABLE: "my-value"
+```
+
+Below is an example of a project structure corresponding to the example above, crucially the `my-container-directory` contains all the files necessary for the container build.
+
+```
+.
+├── my-container-directory
+│   ├── Dockerfile
+│   ├── requirements.txt
+│   ├── server.py
+│   └── (...)
+├── node_modules
+│   ├── serverless-scaleway-functions
+│   └── (...)
+├── package-lock.json
+├── package.json
+└── serverless.yml
+```
+
+Serverless Containers automatically have a `PORT` environment variable set, which indicates which port the container's webserver should be listening on. By default `PORT` is 8080. You can change this via the `port` variable in your container definition.
+
+See the [container example](https://github.com/scaleway/serverless-scaleway-functions/tree/master/examples/container) for more information.

docs/README.md

@@ -0,0 +1,21 @@
+# Custom domains
+
+In addition to the default domain allocated to each function and container, you can also set one or more custom domains.
+
+You can find more information in the Scaleway docs on how to [add custom domains to functions](https://www.scaleway.com/en/docs/compute/functions/how-to/add-a-custom-domain-name-to-a-function/) or
+[add custom domains on containers](https://www.scaleway.com/en/docs/compute/containers/how-to/add-a-custom-domain-to-a-container/).
+
+You can configure custom domains via your `serverless.yml` too, e.g.:
+
+```yaml
+functions:
+  first:
+    handler: handler.handle
+    custom_domains:
+      - my-domain.somehost.com
+      - my-other-domain.somehost.com
+```
+
+Note that you must have a `CNAME` record set up in each domain's DNS configuration, which points to the endpoint of your function or container
+
+**NOTE**: if you create a domain with other tools (e.g. the Scaleway console, the CLI or APIs) you must also add the created domain to your `serverless.yml`. If not, it will be deleted by your Serverless Framework deployment.