Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
pmishev committed Jan 13, 2016
1 parent 11d4952 commit 23c5de2
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 9 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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!
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.
3 changes: 0 additions & 3 deletions Resources/doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion Resources/doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down

0 comments on commit 23c5de2

Please sign in to comment.