From 23c5de29d0a73162e00ce7258392d2f209039a4a Mon Sep 17 00:00:00 2001 From: pmishev Date: Wed, 13 Jan 2016 14:49:26 +0000 Subject: [PATCH] Updated README --- LICENSE | 2 +- README.md | 23 ++++++++++++++++++++--- Resources/doc/index.md | 3 --- Resources/doc/setup.md | 2 +- composer.json | 2 +- 5 files changed, 23 insertions(+), 9 deletions(-) diff --git a/LICENSE b/LICENSE index 4b3cb21..ef21b8c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014-2015 NFQ Technologies UAB, Sineflow Ltd. +Copyright (c) 2015, Sineflow Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c90f34a..6ccab3b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,21 @@ -# ElasticsearchBundle -Integration of default Elasticsearch client with Symfony2 +# Sineflow Elasticsearch Bundle for Symfony -WARNING: This bundle is under heavy development, NOT tested, and NOT production ready! \ No newline at end of file +This bundle was initially based on the [elasticsearch bundle by ONGR.io](https://github.com/ongr-io/ElasticsearchBundle), however a different vision about how some things are handled, and some additional core requirements eventually turned it into a separate project. + +## Key points + +- Uses the official [elasticsearch-php](https://github.com/elastic/elasticsearch-php) client +- Integrates with Symfony 2.7+ and Symfony 3+ +- Uses Doctrine-like entity declarations for Elasticsearch documents +- Supports multilanguage documents +- Supports searching in multiple types and indices +- Supports zero-time reindexing by utilizing read and write index aliases +- Supports data providers for synchronizing Elasticsearch indices with an external data source such as Doctrine + +## Documentation + +Installation instructions and documentation of the bundle can be found [here](Resources/doc/index.md). + +## License + +This bundle is licensed under the MIT license. Please, see the complete license in the [LICENSE](LICENSE) file. \ No newline at end of file diff --git a/Resources/doc/index.md b/Resources/doc/index.md index c4a33db..65d8d3a 100644 --- a/Resources/doc/index.md +++ b/Resources/doc/index.md @@ -17,6 +17,3 @@ The ElasticsearchBundle uses the [official PHP client for Elasticsearch](https:/ #### More details * [Classes diagram](classes.md) - -#### NOTICE -The bundle was originally a fork of the excellent [bundle by ONGR.io](https://github.com/ongr-io/ElasticsearchBundle), however I had a bit different vision about certain things and some additional requirements. Eventually, the codebase was largely refactored to become a separate project, but still sharing a lot of similarities with the original. diff --git a/Resources/doc/setup.md b/Resources/doc/setup.md index efe6e4a..c35fcc0 100644 --- a/Resources/doc/setup.md +++ b/Resources/doc/setup.md @@ -6,7 +6,7 @@ Assuming you have [Composer](https://getcomposer.org) installed globally, enter your project directory and execute the following command to download the latest stable version of this bundle: ``` -$ composer require pmishev/elasticsearch-bundle "~0.2" +$ composer require sineflow/elasticsearch-bundle "~0.4" ``` ### Step 2: Enable the Bundle diff --git a/composer.json b/composer.json index 4851bc7..5d1fe58 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "name": "sineflow/elasticsearch-bundle", "description": "Bundle for integrating official Elasticsearch client with Symfony2", "type": "symfony-bundle", - "homepage": "https://github.com/pmishev/ElasticsearchBundle", + "homepage": "https://github.com/sineflow/ElasticsearchBundle", "license": "MIT", "authors": [ {