silvermine/lambda-express

Write usage documentation

Opened this issue · 1 comments

Need to write usage documentation in the README. It should include:

  • any differences from the API of Express (notably, mounting sub-routers)
  • examples of middleware, request handlers, error handlers
  • hello world

Explanation of the event paths you need, e.g.:

functions:
   api:
      name: 'your-fn-name'
      handler: src/YourAPI.handler
      memorySize: 512
      timeout: 2
      events:
         - http: 'ANY /'
         - http: 'ANY /{proxy+}'