Skip to content

Commit 6ff403c

Browse files
committed
docs(README.md): add prerequisites & remove useless badge
1 parent a8be903 commit 6ff403c

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ coverage/
77
run/
88
.DS_Store
99
*.swp
10-
10+
package-lock.json

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
# egg-oracle
22

33
[![NPM version][npm-image]][npm-url]
4-
[![build status][travis-image]][travis-url]
5-
[![Test coverage][codecov-image]][codecov-url]
64
[![David deps][david-image]][david-url]
75
[![Known Vulnerabilities][snyk-image]][snyk-url]
86
[![npm download][download-image]][download-url]
97

108
[npm-image]: https://img.shields.io/npm/v/egg-oracle.svg?style=flat-square
119
[npm-url]: https://npmjs.org/package/egg-oracle
12-
[travis-image]: https://img.shields.io/travis/cuyl/egg-oracle.svg?style=flat-square
13-
[travis-url]: https://travis-ci.org/cuyl/egg-oracle
14-
[codecov-image]: https://img.shields.io/codecov/c/github/cuyl/egg-oracle.svg?style=flat-square
15-
[codecov-url]: https://codecov.io/github/cuyl/egg-oracle?branch=master
1610
[david-image]: https://img.shields.io/david/cuyl/egg-oracle.svg?style=flat-square
1711
[david-url]: https://david-dm.org/cuyl/egg-oracle
1812
[snyk-image]: https://snyk.io/test/npm/egg-oracle/badge.svg?style=flat-square
@@ -22,6 +16,18 @@
2216

2317
## Install
2418

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/tree/master/INSTALL.md) for details.
29+
30+
2531
```bash
2632
$ npm i egg-oracle --save
2733
```

README.zh_CN.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
# egg-oracle
22

33
[![NPM version][npm-image]][npm-url]
4-
[![build status][travis-image]][travis-url]
5-
[![Test coverage][codecov-image]][codecov-url]
64
[![David deps][david-image]][david-url]
75
[![Known Vulnerabilities][snyk-image]][snyk-url]
86
[![npm download][download-image]][download-url]
97

108
[npm-image]: https://img.shields.io/npm/v/egg-oracle.svg?style=flat-square
119
[npm-url]: https://npmjs.org/package/egg-oracle
12-
[travis-image]: https://img.shields.io/travis/cuyl/egg-oracle.svg?style=flat-square
13-
[travis-url]: https://travis-ci.org/cuyl/egg-oracle
14-
[codecov-image]: https://img.shields.io/codecov/c/github/cuyl/egg-oracle.svg?style=flat-square
15-
[codecov-url]: https://codecov.io/github/cuyl/egg-oracle?branch=master
1610
[david-image]: https://img.shields.io/david/cuyl/egg-oracle.svg?style=flat-square
1711
[david-url]: https://david-dm.org/cuyl/egg-oracle
1812
[snyk-image]: https://snyk.io/test/npm/egg-oracle/badge.svg?style=flat-square

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": "1.0.1",
3+
"version": "1.0.2",
44
"description": "Oracle database plugin for egg",
55
"eggPlugin": {
66
"name": "oracle"

0 commit comments

Comments
 (0)