Skip to content

Commit c35ad23

Browse files
committed
Docs cleanup.
1 parent 6f87080 commit c35ad23

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# ArangoDB JavaScript driver
2+
3+
The official ArangoDB low-level JavaScript client for node.js and browsers.
4+
15
[![Build status](https://img.shields.io/travis/arangodb/arangojs.svg)](https://travis-ci.org/arangodb/arangojs) [![Coverage Status](https://img.shields.io/coveralls/arangodb/arangojs.svg)](https://coveralls.io/r/arangodb/arangojs?branch=master) [![Codacy rating](https://img.shields.io/codacy/5fd86b5508cb4c559fd65e4c8059d800.svg)](https://www.codacy.com/public/me_4/arangojs)
26

37
# Install
@@ -25,12 +29,12 @@ npm run dist
2529

2630
# API
2731

28-
All asynchronous functions take node-style callback functions with the following arguments:
32+
All asynchronous functions take node-style callback functions (or "errbacks") with the following arguments:
2933

3034
* *err*: an *Error* object if an error occurred, or *null* if no error occurred.
31-
* *result*: the function's result (if no error occurred).
35+
* *result*: the function's result (if applicable).
3236

33-
If the server-side ArangoDB API returned an error, *err* will be an instance of *ArangoError*.
37+
For expected API errors, *err* will be an instance of *ArangoError*.
3438

3539
## Database API
3640

package.json

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
{
22
"name": "arangojs",
33
"version": "3.0.0-dev",
4-
"description": "",
4+
"description": "The official ArangoDB JavaScript driver.",
55
"main": "index.js",
6+
"keywords": [
7+
"arango",
8+
"arangodb",
9+
"aql",
10+
"nosql",
11+
"client",
12+
"driver",
13+
"api",
14+
"http",
15+
"rest"
16+
],
617
"files": [
718
"lib/",
819
"index.js",

0 commit comments

Comments
 (0)