Browse Source

Update some metadata to publish to npm

Timothy J. Warren 4 years ago
parent
commit
7b8797c920
4 changed files with 24 additions and 2 deletions
  1. 5
    0
      .npmignore
  2. 6
    0
      README.md
  3. 5
    0
      docs/index.html
  4. 8
    2
      package.json

+ 5
- 0
.npmignore View File

@@ -0,0 +1,5 @@
1
+build
2
+build/*
3
+coverage
4
+coverage/*
5
+tests/config.json

+ 6
- 0
README.md View File

@@ -4,6 +4,12 @@ A node query builder for various SQL databases, based on CodeIgniter's query bui
4 4
 
5 5
 [![Build Status](https://travis-ci.org/timw4mail/node-query.svg?branch=master)](https://travis-ci.org/timw4mail/node-query)
6 6
 
7
+### Supported adapters
8
+	
9
+* mysql
10
+* mysql2
11
+* pg
12
+
7 13
 ### Basic use
8 14
 
9 15
 	var nodeQuery = require('node-query');

+ 5
- 0
docs/index.html View File

@@ -94,6 +94,11 @@
94 94
     <section class="readme-section">
95 95
         <article><h1>Node-query</h1><p>A node query builder for various SQL databases, based on CodeIgniter's query builder.</p>
96 96
 <p><a href="https://travis-ci.org/timw4mail/node-query"><img src="https://travis-ci.org/timw4mail/node-query.svg?branch=master" alt="Build Status"></a></p>
97
+<h3>Supported adapters</h3><ul>
98
+<li>mysql</li>
99
+<li>mysql2</li>
100
+<li>pg</li>
101
+</ul>
97 102
 <h3>Basic use</h3><pre class="prettyprint source"><code>var nodeQuery = require('node-query');
98 103
 
99 104
 var connection = ... // Database module connection 

+ 8
- 2
package.json View File

@@ -1,11 +1,14 @@
1 1
 {
2 2
   "name": "node-query",
3
-  "version": "0.0.0",
3
+  "version": "0.0.1",
4 4
   "description": "A query builder for node based on the one in CodeIgniter",
5 5
   "author": "Timothy J Warren <tim@timshomepage.net>",
6
+  "engines": {
7
+    "node": ">=0.10.0"
8
+  },
6 9
   "repository": {
7 10
     "type": "git",
8
-    "url": "https://github.com/timw4mail/node-query"
11
+    "url": "https://github.com/timw4mail/node-query.git"
9 12
   },
10 13
   "bugs": {
11 14
     "url": "https://github.com/timw4mail/node-query/issues"
@@ -15,6 +18,9 @@
15 18
     "async": "^0.9.0",
16 19
     "getargs": ""
17 20
   },
21
+  "bundledDependencies": [
22
+	"async","getargs"
23
+  ],
18 24
   "devDependencies": {
19 25
     "grunt": "^0.4.5",
20 26
     "grunt-contrib-clean": "^0.6.0",