Skip to content

Commit 7905d9b

Browse files
author
Spencer Alger
committed
added stubs for the different doc pages, [ci skip]
1 parent 540035b commit 7905d9b

File tree

4 files changed

+406
-5
lines changed

4 files changed

+406
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Official *low-level* client for Elasticsearch.
55
## Features
66

77
- One-to-one mapping with REST API and other language clients
8-
- Generalized, pluggable architecture. See [replacing core components](TODO: details the peices that are replaceable)
8+
- Generalized, pluggable architecture. See [replacing core components](docs/replacing_core_components.md)
99
- Configurable, automatic discovery of cluster nodes
1010
- Persistent, Keep-Alive connections
1111
- Load balancing (with pluggable selection strategy) across all available nodes.
@@ -16,7 +16,7 @@ elasticsearch.js works great in node, as well as modern browsers (many thanks to
1616

1717
- Node:
1818

19-
[![Build Status](https://travis-ci.com/elasticsearch/elasticsearch-js)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
19+
[![Build Status](https://magnum.travis-ci.com/spenceralger/elasticsearch-js.png?token=tsFxSKHtVKG8EZavSjXY)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
2020

2121
- Browsers (see [browser builds](#browser-builds)):
2222

@@ -59,6 +59,14 @@ bower install elasticsearch-angular
5959
bower install elasticsearch-jquery
6060
```
6161

62+
## Docs
63+
- [Configuration](#configuration)
64+
- [API](docs/api.md)
65+
- [Replacing Core Components](docs/replacing_core_components.md)
66+
- [Errors](docs/errors.md)
67+
- [Setting Up Logging](docs/setting_up_logging.md)
68+
- [FAQ](#faq)
69+
6270
## Configuration
6371

6472
The `Client` constructor accepts a single object as it's argument, and the following keys can be used to configure that client instance:
@@ -95,7 +103,7 @@ log: {
95103
}
96104
```
97105

98-
Unless a constructor is specified, this sets the output settings for the bundled logger. See [setting up logging](TODO: detail logging why) for more information.
106+
Unless a constructor is specified, this sets the output settings for the bundled logger. See [setting up logging](docs/setting_up_logging.md) for more information.
99107

100108
### connectionClass
101109
Type: `String`, `Constructor`
@@ -148,7 +156,7 @@ Type: `Number`
148156

149157
Defailt: `3`
150158

151-
How many times should the client try to connect to other nodes before returning a [ConnectionFault](TODO: error types) error. (see [node death](#node-death))
159+
How many times should the client try to connect to other nodes before returning a [ConnectionFault](docs/error.md#connectionfault) error. (see [node death](#node-death))
152160

153161
### timeout
154162
Type: `Number`
@@ -202,7 +210,7 @@ The number of milliseconds this request has to complete. It defaults to the time
202210

203211
### Methods
204212

205-
All the methods can be seen [here](TODO: api docs), or take a look at [api.js](src/lib/api.js).
213+
All the methods can be seen [here](docs/api.md), or take a look at [api.js](src/lib/api.js).
206214

207215
### Examples
208216

0 commit comments

Comments
 (0)