Skip to content

Commit 6951903

Browse files
committed
Merge README PR 313 from @KevinSheedy to help first time users
1 parent 7bc10e4 commit 6951903

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# node-oracledb version 1.6
22

3-
## <a name="about"></a> 1. About node-oracledb
3+
## <a name="about"></a> About node-oracledb
44

55
The node-oracledb add-on for Node.js powers high performance Oracle Database applications.
66

@@ -38,6 +38,18 @@ We are actively working on supporting the best Oracle Database
3838
features, and on functionality requests from
3939
[users involved in the project](https://github.com/oracle/node-oracledb/issues).
4040

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+
4153
### A simple query example:
4254

4355
```javascript
@@ -72,42 +84,33 @@ With Oracle's sample HR schema, the output is:
7284
[ [ 60, 'IT' ], [ 90, 'Executive' ], [ 100, 'Finance' ] ]
7385
```
7486

75-
## <a name="examples"></a> 2. Examples
87+
## <a name="examples"></a> Examples
7688

7789
There are examples in the [examples](https://github.com/oracle/node-oracledb/tree/master/examples) directory.
7890

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
8992

9093
See [Documentation for the Oracle Database Node.js Add-on](https://github.com/oracle/node-oracledb/tree/master/doc/api.md).
9194

92-
## <a name="changes"></a> 5. Changes
95+
## <a name="changes"></a> Changes
9396

9497
See [CHANGELOG](https://github.com/oracle/node-oracledb/tree/master/CHANGELOG.md)
9598

9699
*Note* there were two small, backward-compatibility breaking attribute name changes in node-oracledb 0.5.
97100

98-
## <a name="testing"></a> 6. Testsuite
101+
## <a name="testing"></a> Testsuite
99102

100103
To run the included testsuite see [test/README](https://github.com/oracle/node-oracledb/tree/master/test/README.md).
101104

102-
## <a name="contrib"></a> 7. Contributing
105+
## <a name="contrib"></a> Contributing
103106

104-
Node-oracledb is an open source project. See
107+
Node-oracledb is an open source project. See
105108
[CONTRIBUTING](https://github.com/oracle/node-oracledb/tree/master/CONTRIBUTING.md)
106109
for details.
107110

108111
Oracle gratefully acknowledges the contributions to node-oracledb that have been made by the community.
109112

110-
## <a name="license"></a> 8. License
113+
## <a name="license"></a> License
111114

112115
Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
113116

0 commit comments

Comments
 (0)