-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
60674b2
commit 5007c30
Showing
3 changed files
with
128 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) OpenGento | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Document Module for Magento 2 | ||
|
||
[![Latest Stable Version](https://img.shields.io/packagist/v/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search) | ||
[![License: MIT](https://img.shields.io/github/license/opengento/magento2-document-search.svg?style=flat-square)](./LICENSE) | ||
[![Packagist](https://img.shields.io/packagist/dt/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search/stats) | ||
[![Packagist](https://img.shields.io/packagist/dm/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search/stats) | ||
|
||
This module aims to make documents searchable for customers in Magento 2. | ||
|
||
- [Setup](#setup) | ||
- [Composer installation](#composer-installation) | ||
- [Setup the module](#setup-the-module) | ||
- [Features](#features) | ||
- [Settings](#settings) | ||
- [Documentation](#documentation) | ||
- [Support](#support) | ||
- [Authors](#authors) | ||
- [License](#license) | ||
|
||
## Setup | ||
|
||
Magento 2 Open Source or Commerce edition is required. | ||
|
||
### Composer installation | ||
|
||
Run the following composer command: | ||
|
||
``` | ||
composer require opengento/module-document-search | ||
``` | ||
|
||
### Setup the module | ||
|
||
Run the following magento command: | ||
|
||
``` | ||
bin/magento setup:upgrade | ||
``` | ||
|
||
**If you are in production mode, do not forget to recompile and redeploy the static resources.** | ||
|
||
## Features | ||
|
||
This module aims to make documents searchable for customers in Magento 2. | ||
Documents can be searchable if their visibility is set to `search`. | ||
|
||
## Documentation | ||
|
||
You can change the full search behavior by using the collection modifier extension point. | ||
Add you own `Magento\Framework\Data\CollectionModifierInterface` implementation to the modifiers list of: | ||
|
||
`\Opengento\DocumentSearch\Model\Collection\CollectionModifier` | ||
|
||
Query parameters can be read through: `\Opengento\DocumentSearch\Model\QueryData` | ||
|
||
## Support | ||
|
||
Raise a new [request](https://github.com/opengento/magento2-document-search/issues) to the issue tracker. | ||
|
||
## Authors | ||
|
||
- **Opengento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento) | ||
- **Thomas Klein** - *Maintainer* - [![GitHub followers](https://img.shields.io/github/followers/thomas-kl1.svg?style=social)](https://github.com/thomas-kl1) | ||
- **Contributors** - *Contributor* - [![GitHub contributors](https://img.shields.io/github/contributors/opengento/magento2-document-search.svg?style=flat-square)](https://github.com/opengento/magento2-document-search/graphs/contributors) | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details. | ||
|
||
***That's all folks!*** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters