QuickStart guide - Register extension

Author: Spamercz

doc/00_quick_start.md

@@ -0,0 +1,35 @@
+# Quick Start
+
+## 1. Install
+
+Use composer to install this library.
+```bash
+composer require spameri/elastic
+```
+
+## 2. Configure
+
+You need to set up few things first, before you can dive into ElasticSearch.
+
+### I. Register extension
+
+In your configuration neon file you need to add these lines to `extension:` section.
+
+```yaml
+extensions:
+	spameriElasticSearch: \Spameri\Elastic\DI\SpameriElasticSearchExtension
+	console: Kdyby\Console\DI\ConsoleExtension
+	monolog: Kdyby\Monolog\DI\MonologExtension
+```
+
+
+
+
+
+
+
+
+
+
+
+

doc/01_intro.md

@@ -13,19 +13,19 @@ Monolog is required by elasticsearch/elasticsearch and we can use existing exten
 
 ```neon
 extensions:
-	elasticSearch: \Spameri\Elastic\DI\ElasticSearchExtension
+	spameriElasticSearch: \Spameri\Elastic\DI\SpameriElasticSearchExtension
 	console: Kdyby\Console\DI\ConsoleExtension
 	monolog: Kdyby\Monolog\DI\MonologExtension
 ```
 
 Then configure where is your ElasticSearch.
 ```neon
-elasticSearch:
+spameriElasticSearch:
 	host: 127.0.0.1
 	port: 9200
 ```
 
-For more config options see default values in `\Spameri\Elastic\DI\ElasticSearchExtension::$defaults`. [Here](../src/DI/ElasticSearchExtension.php#L9).
+For more config options see default values in `\Spameri\Elastic\DI\SpameriElasticSearchExtension::$defaults`. [Here](../src/DI/ElasticSearchExtension.php#L9).
 
 #### Raw client usage
 - After this configuration you are ready to use ElasticSearch in your Nette application.

doc/02_neon_configuration.md

@@ -13,7 +13,7 @@ have to worry about it because of type deprecation. More details here https://ww
 - Entity definition is in neon under namespace `elasticSearch.entities.EntityName` 
 continuing our example in file `app/ProductModule/Config/Product.neon`:
 ```neon
-elasticSearch:
+spameriElasticSearch:
 	entities:
 		Product:
 			index: shop_product
@@ -25,15 +25,15 @@ This means newly introduced fields not specified in mapping will throw error whe
 all fields introduced and specify their type. But if your application can add fields as needed you need to remember this
 strict limitation or just do not enable it.
 ```neon
-elasticSearch:
+spameriElasticSearch:
 	entities:
 		Product:
 			dynamic: strict
 ```
 - Now to specify entity mapping. Each object or encapsulation of sub fields stars with `properties:` then property name
 and under it you can specify type and analyzer. 
 ```neon
-elasticSearch:
+spameriElasticSearch:
 	entities:
 		Product:
 			properties: 
@@ -46,7 +46,7 @@ elasticSearch:
 - ElasticSearch default analyzers: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html
 - Subfields example:
 ```neon
-elasticSearch:
+spameriElasticSearch:
 	entities:
 		Product:
 			properties: 

tests/SpameriTests/Data/Config/Common.neon

@@ -1,7 +1,7 @@
 extensions:
-	elasticSearch: Spameri\Elastic\DI\ElasticSearchExtension
+	spameriElasticSearch: Spameri\Elastic\DI\SpameriElasticSearchExtension
 
-elasticSearch:
+spameriElasticSearch:
 	host: 127.0.0.1
 	port: 9200
 

tests/SpameriTests/Data/Config/Person.neon

@@ -1,4 +1,4 @@
-elasticSearch:
+spameriElasticSearch:
 	entities:
 		Person:
 			index: spameri_person

tests/SpameriTests/Data/Config/Video.neon

@@ -1,4 +1,4 @@
-elasticSearch:
+spameriElasticSearch:
 	entities:
 		Video:
 			index: spameri_video