|
1 | 1 | # node-oracledb version 1.6
|
2 | 2 |
|
3 |
| -## <a name="about"></a> 1. About node-oracledb |
| 3 | +## <a name="about"></a> About node-oracledb |
4 | 4 |
|
5 | 5 | The node-oracledb add-on for Node.js powers high performance Oracle Database applications.
|
6 | 6 |
|
@@ -38,6 +38,18 @@ We are actively working on supporting the best Oracle Database
|
38 | 38 | features, and on functionality requests from
|
39 | 39 | [users involved in the project](https://github.com/oracle/node-oracledb/issues).
|
40 | 40 |
|
| 41 | +## <a name="installation"></a> Installation |
| 42 | + |
| 43 | +Prerequisites: |
| 44 | + |
| 45 | +- [Python 2.7](https://www.python.org/downloads/) |
| 46 | +- C++ Compiler (GCC, Visual Studio or similar) |
| 47 | +- Install the small, free [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-100365.html) libraries if your database is remote. Or use a locally installed database such as the free [Oracle XE](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) release. |
| 48 | + |
| 49 | + `npm install oracledb` to install from the [NPM registry](https://www.npmjs.com/package/oracledb). |
| 50 | + |
| 51 | +See [INSTALL](https://github.com/oracle/node-oracledb/tree/master/INSTALL.md) for details. |
| 52 | + |
41 | 53 | ### A simple query example:
|
42 | 54 |
|
43 | 55 | ```javascript
|
@@ -72,42 +84,33 @@ With Oracle's sample HR schema, the output is:
|
72 | 84 | [ [ 60, 'IT' ], [ 90, 'Executive' ], [ 100, 'Finance' ] ]
|
73 | 85 | ```
|
74 | 86 |
|
75 |
| -## <a name="examples"></a> 2. Examples |
| 87 | +## <a name="examples"></a> Examples |
76 | 88 |
|
77 | 89 | There are examples in the [examples](https://github.com/oracle/node-oracledb/tree/master/examples) directory.
|
78 | 90 |
|
79 |
| -## <a name="installation"></a> 3. Installation |
80 |
| - |
81 |
| -The basic install steps are: |
82 |
| - |
83 |
| -- Install the small, free [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-100365.html) libraries if your database is remote. Or use a locally installed database such as the free [Oracle XE](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) release. |
84 |
| -- Run `npm install oracledb` to install from the [NPM registry](https://www.npmjs.com/package/oracledb). |
85 |
| - |
86 |
| -See [INSTALL](https://github.com/oracle/node-oracledb/tree/master/INSTALL.md) for details. |
87 |
| - |
88 |
| -## <a name="doc"></a> 4. Documentation |
| 91 | +## <a name="doc"></a> Documentation |
89 | 92 |
|
90 | 93 | See [Documentation for the Oracle Database Node.js Add-on](https://github.com/oracle/node-oracledb/tree/master/doc/api.md).
|
91 | 94 |
|
92 |
| -## <a name="changes"></a> 5. Changes |
| 95 | +## <a name="changes"></a> Changes |
93 | 96 |
|
94 | 97 | See [CHANGELOG](https://github.com/oracle/node-oracledb/tree/master/CHANGELOG.md)
|
95 | 98 |
|
96 | 99 | *Note* there were two small, backward-compatibility breaking attribute name changes in node-oracledb 0.5.
|
97 | 100 |
|
98 |
| -## <a name="testing"></a> 6. Testsuite |
| 101 | +## <a name="testing"></a> Testsuite |
99 | 102 |
|
100 | 103 | To run the included testsuite see [test/README](https://github.com/oracle/node-oracledb/tree/master/test/README.md).
|
101 | 104 |
|
102 |
| -## <a name="contrib"></a> 7. Contributing |
| 105 | +## <a name="contrib"></a> Contributing |
103 | 106 |
|
104 |
| -Node-oracledb is an open source project. See |
| 107 | +Node-oracledb is an open source project. See |
105 | 108 | [CONTRIBUTING](https://github.com/oracle/node-oracledb/tree/master/CONTRIBUTING.md)
|
106 | 109 | for details.
|
107 | 110 |
|
108 | 111 | Oracle gratefully acknowledges the contributions to node-oracledb that have been made by the community.
|
109 | 112 |
|
110 |
| -## <a name="license"></a> 8. License |
| 113 | +## <a name="license"></a> License |
111 | 114 |
|
112 | 115 | Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
|
113 | 116 |
|
|
0 commit comments