Skip to content

Commit 8143d07

Browse files
authored
doc: Readme updated
1 parent 6de3694 commit 8143d07

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# lambda-expressless (WIP)
1+
# lambda-expressless
22

33
[![Build Status](https://travis-ci.org/muratcorlu/lambda-expressless.svg?branch=master)](https://travis-ci.org/muratcorlu/lambda-expressless) [![npm version](https://badge.fury.io/js/lambda-expressless.svg)](https://www.npmjs.com/package/lambda-expressless) [![codecov](https://codecov.io/gh/muratcorlu/lambda-expressless/branch/master/graph/badge.svg)](https://codecov.io/gh/muratcorlu/lambda-expressless) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
44

@@ -59,6 +59,9 @@ const getUser = (req, res) => {
5959

6060
exports.handler = use(checkUser, getUser);
6161
```
62+
## Installation
63+
64+
```npm i lambda-expressless```
6265

6366
## Supported Features and Limitations
6467

@@ -95,3 +98,13 @@ Methods:
9598
| [status()](https://expressjs.com/en/4x/api.html#res.status) | - |
9699
| [end()](https://expressjs.com/en/4x/api.html#res.end) | - |
97100
| [json()](https://expressjs.com/en/4x/api.html#res.json) | - |
101+
102+
## Contribution
103+
104+
Every contribution is very welcome. Keep these in your mind when you want to make a contribution:
105+
106+
1. Because of we use [semantic-release](https://github.com/semantic-release/semantic-release) you need to use [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) in your commit messages.
107+
2. Keep code coverage 100% with your updated tests.
108+
3. Check your changes with a Lambda environment. You can use [SAM-CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) to test on your local.
109+
4. Don't forget to update documentation(this readme file) about your changes.
110+

0 commit comments

Comments
 (0)