aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan Tuomi <jan.tuomi@eficode.com>2018-07-12 16:23:33 +0300
committerJan Tuomi <jan.tuomi@eficode.com>2018-07-12 16:23:33 +0300
commit0b4ebb81270f016bb7e5ed0e95e5e07146c03f0f (patch)
tree56da53cade12e4e47ba7fd429386b39b3c9b96ac
parent00bb5585f28773acdc742800181ce22ec41b5415 (diff)
Improve README.md
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5912e4f..676d02b 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,17 @@ module.exports = function (req, res) {
`req` and `res` are Express objects.
+# Developing functions
+
+Implement the following in your function file.
+
+* Export a function (with `module.exports`).
+* Use the parameters `req` (request), `res` (response) and optionally, `secrets`.
+
+To test your function, use the `start dev <file>` command in the `faaslift` CLI. Use `stop dev` to stop the server.
+
+To `require` 3rd party libraries, they have to be installed on the host server with NPM.
+
# Security
The functions are *NOT* containerized in any way! This means that code running at an endpoint is e.g. able to crash the server or manipulate other endpoints, among other evil deeds, with a little bit of tinkering. That's why this project is solely meant for prototyping purposes.