Skip to content

Commit d0f9106

Browse files
committed
feat(docs): update README.md
1 parent 8dd5cf3 commit d0f9106

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
# PhoenixElasticsearchBundle
22

3-
- [Core library](#core-library)
4-
- [Manual installation](#manual-installation)
3+
The bundle works like a bridge to integrate Elasticsearch in Symfony. It provides developer APIs and eco-system to work with Elasticsearch easily using dependency injection (DI).
4+
5+
- [Features](#features)
6+
- [Installation](#installation)
57
- [Usage](#usage)
68
- [Commands](#commands)
9+
- [Server](#server-related-commands)
10+
- [Index](#index-related-commands)
11+
- [Document](#document-related-commands)
712
- [Todo](#todo)
813
- [Roadmap](#roadmap)
9-
- [Brainstroming](#brainstroming)
14+
- [Core library](#core-library)
1015

11-
## Core library
16+
## Features
1217

13-
- https://packagist.org/packages/elasticsearch/elasticsearch
14-
- https://packagist.org/packages/ongr/elasticsearch-dsl
18+
- Server status and information
19+
- Index management
20+
- Document management
1521

16-
## Manual installation
22+
## Installation
1723

1824
- Clone repository.
1925

@@ -22,14 +28,11 @@
2228
git clone https://gitlab.com/phoenix-code-labs/phoenix/phoenix-elasticsearch-bundle.git
2329
```
2430

25-
- Install dependancies.
31+
- Install dependencies.
2632

2733
```sh
2834
# https://packagist.org/packages/elasticsearch/elasticsearch
2935
composer require elasticsearch/elasticsearch
30-
31-
# https://packagist.org/packages/ongr/elasticsearch-dsl
32-
composer require ongr/elasticsearch-dsl
3336
```
3437
- Autoload bundle with composer.json.
3538

@@ -44,6 +47,12 @@ composer require ongr/elasticsearch-dsl
4447
},
4548
```
4649

50+
- Dump autoload with composer
51+
52+
```sh
53+
composer dump-autoload
54+
```
55+
4756
- Add new bundle in config/bundles.php.
4857

4958
```php
@@ -52,6 +61,7 @@ return [
5261
Phoenix\ElasticsearchBundle\PhoenixElasticsearchBundle::class => ['all' => true],
5362
]
5463
```
64+
5565
## Usage
5666

5767
### Create index class and register it as service with 'es.index' tag:
@@ -520,4 +530,6 @@ php bin/console phoenix:elasticsearch:document --index=location --id=10 get
520530
- Aggregation
521531
- Remove bundle and convert this into component
522532

523-
## Brainstroming
533+
## Core library
534+
535+
- https://packagist.org/packages/elasticsearch/elasticsearch

0 commit comments

Comments
 (0)