Skip to content

Commit d5d3494

Browse files
update readme, ignore and package file
1 parent 439181b commit d5d3494

File tree

3 files changed

+31
-9
lines changed

3 files changed

+31
-9
lines changed

.npmignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ignore the testing folder
2+
/tests
3+
4+
# ignore the readme
5+
readme.md

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ You can also configure your options to sort the results of your query by 1 or mo
6161
6262
```
6363
npm i --save sequelize
64-
// TODO: add the npm link here
64+
npm i --save sequelizeqp
6565
```
6666

6767
## How to Use
6868

6969
```javascript
70-
const SequelizeQS = require(''); // TODO: add the npm bit here
70+
const SequelizeQS = require('sequelizeqp');
7171
const sequelizeParser = SequelizeQS();
7272
```
7373

package.json

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
{
2-
"name": "sequelize-query-string",
3-
"version": "1.0.0",
4-
"description": "",
2+
"name": "sequelizeqp",
3+
"version": "1.0.1",
4+
"description": "Small library to convert express query params (or objects in general) into a syntax recognised by the Sequelize library.",
55
"main": "index.js",
66
"scripts": {
77
"test": "cd tests && mocha"
88
},
9-
"keywords": [],
10-
"author": "",
11-
"license": "ISC",
9+
"keywords": [
10+
"pagination",
11+
"parser",
12+
"sorting",
13+
"query",
14+
"express",
15+
"sequelize",
16+
"query-builder",
17+
"query-parser"
18+
],
19+
"author": "Stuart Harrison",
20+
"license": "GNU GPLv3",
1221
"devDependencies": {
1322
"mocha": "^10.0.0",
1423
"sqlite3": "^5.0.8"
1524
},
1625
"dependencies": {
1726
"sequelize": "^6.21.2"
18-
}
27+
},
28+
"repository": {
29+
"type": "git",
30+
"url": "git+https://github.com/stuartaharrison/sequelize-query-parser.git"
31+
},
32+
"bugs": {
33+
"url": "https://github.com/stuartaharrison/sequelize-query-parser/issues"
34+
},
35+
"homepage": "https://github.com/stuartaharrison/sequelize-query-parser#readme"
1936
}

0 commit comments

Comments
 (0)