Skip to content

Write usage documentation #16

Open
Open
Write usage documentation#16
Assignees
jthomerson
Milestone
1.0.0

Description

@jthomerson
jthomerson
opened on 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

Activity

  1. jthomerson
    added this to the 1.0.0 milestone on Feb 26, 2019
  2. jthomerson
    self-assigned this
    on Feb 26, 2019

  3. jthomerson commented on Feb 28, 2019

    @jthomerson
    jthomerson
    on Feb 28, 2019
    MemberAuthor

    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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions