Skip to content

Commit 7105a35

Browse files
committed
📝 slightly rearrange the README file and added contribution info
1 parent a08450a commit 7105a35

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,19 @@ AWS Lambda function execution contexts. This reduces the load on
1212
the database. However, this client is not natively supported by
1313
Knex. This library solves the problem.
1414

15-
## Simple Example
15+
## Getting Started
16+
17+
### Installation
18+
19+
```
20+
yarn add knex-serverless-mysql
21+
22+
# or
23+
24+
npm install knex-serverless-mysql
25+
```
26+
27+
### Simple Example
1628

1729
```js
1830
const Knex = require('knex');
@@ -37,7 +49,7 @@ exports.run = function () {
3749
}
3850
```
3951

40-
## Usage with [datasource-sql]
52+
### Usage with [datasource-sql]
4153

4254
```js
4355
const Knex = require('knex');
@@ -71,15 +83,12 @@ exports.run = function () {
7183
}
7284
```
7385

74-
## Installation
86+
## Contributing
7587

76-
```
77-
yarn add knex-serverless-mysql
88+
All contributions are welcome!
7889

79-
# or
90+
Please open an issue or pull request.
8091

81-
npm install knex-serverless-mysql
82-
```
8392

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

0 commit comments

Comments
 (0)