Skip to content

Commit 626bb62

Browse files
committed
docs intro section
1 parent 1fe5d73 commit 626bb62

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ MySql client for node.js. Written in native JavaScript and aims to be mostly api
2323

2424
## Documentation
2525

26-
See [node-mysql](https://github.com/felixge/node-mysql) documentation. If you see api incompatibilities, please report via github issue.
2726

28-
Below is a list of extensions not supported by node-mysql:
2927

3028
### Promise wrappers
3129

documentation/Readme.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
### Documentation
2+
3+
`Node-MySQL2` is aims to be a drop in replacement for [node-mysql](https://github.com/felixge/node-mysql). Please check `node-mysql` for full documentation.
4+
5+
**Note :** *If you see any API incompatibilities with `node-mysql`, please report via github issue.*
6+
7+
Not only `Node-MySQL2` offer a better performance over `node-mysql`, we also support these features.
8+
9+
- [Prepared Statements]()
10+
- [Promise Wrapper]()
11+
- [Authentication Switch]()
12+
- [Named Placeholders]()
13+
- [MySQL Server]()
14+
- [Other Features]()

0 commit comments

Comments
 (0)