Moved comments in README.md

This commit is contained in:
Fedele Mantuano 2015-09-04 22:27:57 +02:00
commit e806b1ae60
2 changed files with 14 additions and 23 deletions

View file

@ -1,13 +1,21 @@
elasticsearch elasticsearch
======= =======
This plugin makes easy to use Elasticsearch API and it also offering autocomplete for common APIs. This plugin makes easy to use Elasticsearch API and it also offering autocomplete for common APIs.
There are `GET`, `HEAD`, `DELETE`, `PUT` and `POST` commands. There are [`GET`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html),
[`HEAD`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html),
[`DELETE`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html),
[`PUT`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html) and
[`POST`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html) commands.
Examples usage: Examples usage:
- `GET _cluster/health` - `GET _cluster/health`
- `GET _nodes/stats`
- `GET _stats/fielddata?fields=*`
- `GET _nodes/stats/indices/fielddata?fields=*`
- `GET _cat` - `GET _cat`
- `DELETE twitter` - `DELETE twitter`
You should install [`json_reformat`](http://dev.man-online.org/package/main/yajl-tools/) to format json output.
Aliases Aliases
------- -------
@ -16,3 +24,8 @@ Aliases
- `alias ecs='GET _cluster/state'`: Allows to get a comprehensive state information of the whole cluster - `alias ecs='GET _cluster/state'`: Allows to get a comprehensive state information of the whole cluster
- `alias ens='GET _nodes/stats'`: Allows to retrieve all of the cluster nodes statistics - `alias ens='GET _nodes/stats'`: Allows to retrieve all of the cluster nodes statistics
- `alias esf='GET _stats/fielddata'`: Field data memory usage on index level - `alias esf='GET _stats/fielddata'`: Field data memory usage on index level
Author
-------
Fedele Mantuano (**Twitter**: [@fedelemantuano](https://twitter.com/fedelemantuano))

View file

@ -1,25 +1,3 @@
# ------------------------------------------------------------------------------
# Description
# -----------
#
# You can use Elastichsearch GET API like in Marvel sense console:
# GET /
# GET _cluster/health
# GET _nodes/stats
# GET _stats/fielddata?fields=*
# GET _nodes/stats/indices/fielddata?fields=*
#
# You have do install json_reformat (http://dev.man-online.org/package/main/yajl-tools/)
# to format json
#
# ------------------------------------------------------------------------------
# Author
# -------
#
# * Fedele Mantuano (Twitter: @fedelemantuano)
#
# ------------------------------------------------------------------------------
alias ech='GET _cluster/health' alias ech='GET _cluster/health'
alias ecs='GET _cluster/state' alias ecs='GET _cluster/state'
alias ens='GET _nodes/stats' alias ens='GET _nodes/stats'