From 94ea8984eae3d827ececedb8821138d75872245d Mon Sep 17 00:00:00 2001 From: tiefenb Date: Tue, 21 May 2019 09:54:07 +0200 Subject: [PATCH] Make Module ready for composer --- composer.json | 23 +++++++++++++++++++++++ readme.md | 8 ++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 composer.json diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..ee54ffb --- /dev/null +++ b/composer.json @@ -0,0 +1,23 @@ +{ + "name": "blue-tomato/elasticsearchfeeder", + "type": "pw-module", + "description": "Schema-flexible ProcessWire module for getting your page into cloudhosted Elasticsearch like Bonsai", + "keywords": [ "elasticsearch", "elastic", "bonsai", "processwire"], + "homepage": "https://github.com/blue-tomato/ElasticsearchFeeder", + "license": "MIT", + "authors": [ + { + "name": "Blue Tomato", + "email": "developer@blue-tomato.com", + "homepage": "https://github.com/blue-tomato" + }, + { + "name": "ElasticsearchFeeder Contributors", + "homepage": "https://github.com/blue-tomato/ElasticsearchFeeder/contributors" + } + ], + "require": { + "php": ">=7.0", + "hari/pw-module": "~1.0", + } +} diff --git a/readme.md b/readme.md index 7568f01..c0888a4 100644 --- a/readme.md +++ b/readme.md @@ -33,8 +33,12 @@ Usually ES SaaS providers inform about this in a setup/configuration section in ## Installation -To install this module... -1. paste the `ElasticsearchFeeder` folder to your `modules` directory in `/site/modules`. +1. Execute the following command in the root directory of your ProcessWire installation: + +``` +composer require blue-tomato/elasticsearchfeeder +``` + 2. ProcessWire will detect the module and list it in the backend's `Modules` > `Site` > `ElasticsearchFeeder` section. Navigate there and install it. *NOTE: Installing the module will add a `elasticsearch_lastindex` field to your templates when the page gets indexed initially (so on runtime), which will only be visible to superusers.*