Skip to content

Commit dceb937

Browse files
committed
chore: documentation
1 parent 9c40804 commit dceb937

File tree

2 files changed

+7
-11
lines changed

2 files changed

+7
-11
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,7 @@
1616

1717
## Install
1818

19-
> Prerequisites:
20-
>
21-
> - [Python 2.7](https://www.python.org/downloads/)
22-
> - C Compiler with support for C++ 11 (Xcode, gcc, Visual Studio or similar)
23-
> - Oracle 11.2, 12.1 or 12.2 client libraries. Use the small, free [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-100365.html) "basic" and "SDK" packages if your database is remote. Or use the libraries and headers from a locally installed database such as the free [Oracle XE](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) release.
24-
>
25-
> Oracle's standard client-server network compatibility applies: Oracle Client 12.2 can connect to Oracle Database 11.2 or greater. Oracle Client 12.1 can connect to Oracle Database 10.2 or greater. Oracle Client 11.2 can connect to Oracle Database 9.2 or greater.
26-
> - Set `OCI_LIB_DIR` and `OCI_INC_DIR` during installation if the Oracle libraries and headers are in non-default location
27-
>
28-
> See [INSTALL](https://github.com/oracle/node-oracledb/blob/d93d86ce15b5bd2a02c0c276a23c2997e9beedea/INSTALL.md) for details.
19+
See [Quick Start Node-oracledb Installation](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md#quickstart).
2920

3021

3122
```bash
@@ -68,6 +59,11 @@ class MyService extends Service {
6859
module.exports = MyService;
6960

7061
```
62+
63+
## <a name="doc"></a> Documentation
64+
65+
See [Documentation for the Oracle Database Node.js Add-on](https://github.com/oracle/node-oracledb/blob/master/doc/api.md).
66+
7167
## Configuration
7268

7369
```js

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "egg-oracle",
3-
"version": "2.0.0",
3+
"version": "2.0.2",
44
"description": "Oracle database plugin for egg",
55
"eggPlugin": {
66
"name": "oracle"

0 commit comments

Comments
 (0)