Skip to content

Commit faaa61f

Browse files
committed
NPM package published, readme updated
1 parent 3cfcb13 commit faaa61f

File tree

2 files changed

+7
-17
lines changed

2 files changed

+7
-17
lines changed

README.md

+5-17
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,13 @@ NPM Package to provide events when a MySQL select statement result set changes.
44

55
Built using the [`zongji` Binlog Tailer](https://github.com/nevill/zongji) and [`node-mysql`](https://github.com/felixge/node-mysql) projects.
66

7-
## *Under Construction*
8-
9-
This package is not yet completed. In order to test it, you must clone the repo. Please use the following command sequence as a guide:
10-
11-
```bash
12-
$ git clone https://github.com/numtel/mysql-live-select.git
13-
$ cd mysql-live-select
14-
$ npm install
15-
# To use example as-is, copy example data into MySQL
16-
$ mysql < example.sql
17-
# Configure example to match your MySQL settings
18-
# (Be sure to also to enable the binary log, as described in next section)
19-
$ vim example.js
20-
# Run example
21-
$ node example.js
22-
```
23-
247
## Installation
258

9+
* Add the package to your project:
10+
```bash
11+
$ npm install mysql-live-select
12+
```
13+
2614
* Enable MySQL binlog in `my.cnf`, restart MySQL server after making the changes.
2715

2816
```

example.js

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/* mysql-live-select, MIT License [email protected]
2+
example.js - Use mysql < example.sql to get started */
13
var LiveMysql = require('./');
24

35
var settings = {

0 commit comments

Comments
 (0)