New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write usage documentation #16

Open

jthomerson opened this issue Feb 26, 2019 · 1 comment

Assignees

Milestone

Member

jthomerson commented Feb 26, 2019

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

jthomerson added this to the 1.0.0 milestone

jthomerson self-assigned this

Member Author

jthomerson commented Feb 28, 2019

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+}'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment