Skip to content

Commit

Permalink
Merge pull request #30 from traveltime-dev/readme-update
Browse files Browse the repository at this point in the history
Update README to not include a plugin version
  • Loading branch information
mjanuszkiewicz-tt authored Jul 2, 2024
2 parents 890640c + 5b79338 commit 7e80929
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Plugin for Elasticsearch that allows users to filter locations using the Travelt
We maintain separate codebases for each ElasticSearch version between 7.10 and 8.1 (inclusive), and version 5.5. They reside in the appropriate folders (e.g. the plugin for version 7.16 is in the `7.16` folder).

## Installation & configuration
This is a standard Elasticsearch plugin. As such it can be installed by running `elasticsearch-plugin install https://github.com/traveltime-dev/traveltime-elasticsearch-plugin/releases/download/v0.2.27/traveltime-elasticsearch-plugin_v0.2.27_8.1.0.zip`
This is a standard Elasticsearch plugin. As such it can be installed by running `elasticsearch-plugin install https://github.com/traveltime-dev/traveltime-elasticsearch-plugin/releases/download/${PLUGIN_VERSION}/traveltime-elasticsearch-plugin_${PLUGIN_VERSION}_${ES_VERSION}.zip`, where `PLUGIN_VERSION` is the latest plugin version available at https://github.com/traveltime-dev/traveltime-elasticsearch-plugin/releases (e.g. `v0.2.35`), and `ES_VERSION` is the exact version string of the Elasticsearch instance the plugin will be installed to (e.g. `7.17.14`)

To use the plugin you **must** specify the following configuration keys:
- `traveltime.app.id`: this is you API app id.
Expand Down

0 comments on commit 7e80929

Please sign in to comment.