Skip to content

Commit

Permalink
📝 slightly rearrange the README file and added contribution info
Browse files Browse the repository at this point in the history
  • Loading branch information
MatissJanis committed Apr 24, 2021
1 parent a08450a commit 7105a35
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@ AWS Lambda function execution contexts. This reduces the load on
the database. However, this client is not natively supported by
Knex. This library solves the problem.

## Simple Example
## Getting Started

### Installation

```
yarn add knex-serverless-mysql
# or
npm install knex-serverless-mysql
```

### Simple Example

```js
const Knex = require('knex');
Expand All @@ -37,7 +49,7 @@ exports.run = function () {
}
```

## Usage with [datasource-sql]
### Usage with [datasource-sql]

```js
const Knex = require('knex');
Expand Down Expand Up @@ -71,15 +83,12 @@ exports.run = function () {
}
```

## Installation
## Contributing

```
yarn add knex-serverless-mysql
All contributions are welcome!

# or
Please open an issue or pull request.

npm install knex-serverless-mysql
```

[serverless-mysql]: https://github.com/jeremydaly/serverless-mysql
[datasource-sql]: https://github.com/cvburgess/SQLDataSource

0 comments on commit 7105a35

Please sign in to comment.