Skip to content

Commit

Permalink
Make Module ready for composer
Browse files Browse the repository at this point in the history
  • Loading branch information
tiefenb committed May 21, 2019
1 parent f85879d commit 94ea898
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
23 changes: 23 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -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",
}
}
8 changes: 6 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down

0 comments on commit 94ea898

Please sign in to comment.