Skip to content

Commit 7505803

Browse files
committed
Merge branch 'add-docs-gitattributes' into 7.4
2 parents af91d6c + ddebfa0 commit 7505803

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
/ruleset.xml export-ignore
1414
/travis export-ignore
1515
/util export-ignore
16+
/docs export-ignore

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,33 @@ elasticsearch-php
33

44
[![Build Status](https://travis-ci.org/elastic/elasticsearch-php.svg?branch=master)](https://travis-ci.org/elastic/elasticsearch-php) [![Latest Stable Version](https://poser.pugx.org/elasticsearch/elasticsearch/v/stable)](https://packagist.org/packages/elasticsearch/elasticsearch) [![Total Downloads](https://poser.pugx.org/elasticsearch/elasticsearch/downloads)](https://packagist.org/packages/elasticsearch/elasticsearch)
55

6-
76
Official low-level client for Elasticsearch. Its goal is to provide common ground for all Elasticsearch-related code in PHP; because of this it tries to be opinion-free and very extendable.
87

98
To maintain consistency across all the low-level clients (Ruby, Python, etc.), clients accept simple associative arrays as parameters. All parameters, from the URI to the document body, are defined in the associative array.
109

1110
Starting from version 7.4.0, all the endpoints (and namespaces) are autogenerated using the [util/GenerateEndpoints.php](https://github.com/elastic/elasticsearch-php/blob/master/util/GenerateEndpoints.php) script. This script reads the [Elasticsearch API specs](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/api) and generated the PHP classes for all the endpoints.
1211

12+
Table of Contents
13+
=================
14+
15+
- [elasticsearch-php](#elasticsearch-php)
16+
* [Features](#features)
17+
* [Version Matrix](#version-matrix)
18+
* [Documentation](#documentation)
19+
* [Installation via Composer](#installation-via-composer)
20+
* [PHP Version Requirement](#php-version-requirement)
21+
* [Quickstart](#quickstart)
22+
+ [Index a document](#index-a-document)
23+
+ [Get a document](#get-a-document)
24+
+ [Search for a document](#search-for-a-document)
25+
+ [Delete a document](#delete-a-document)
26+
+ [Delete an index](#delete-an-index)
27+
+ [Create an index](#create-an-index)
28+
- [Unit Testing using Mock a Elastic Client](#unit-testing-using-mock-a-elastic-client)
29+
- [Wrap up](#wrap-up)
30+
* [Available Licenses](#available-licenses)
31+
+ [Contributions](#contributions)
32+
1333
Features
1434
--------
1535

0 commit comments

Comments
 (0)