Skip to content

Commit 5007c30

Browse files
committed
update doc
1 parent 60674b2 commit 5007c30

File tree

3 files changed

+128
-5
lines changed

3 files changed

+128
-5
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) OpenGento
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Document Module for Magento 2
2+
3+
[![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)
4+
[![License: MIT](https://img.shields.io/github/license/opengento/magento2-document-search.svg?style=flat-square)](./LICENSE)
5+
[![Packagist](https://img.shields.io/packagist/dt/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search/stats)
6+
[![Packagist](https://img.shields.io/packagist/dm/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search/stats)
7+
8+
This module aims to make documents searchable for customers in Magento 2.
9+
10+
- [Setup](#setup)
11+
- [Composer installation](#composer-installation)
12+
- [Setup the module](#setup-the-module)
13+
- [Features](#features)
14+
- [Settings](#settings)
15+
- [Documentation](#documentation)
16+
- [Support](#support)
17+
- [Authors](#authors)
18+
- [License](#license)
19+
20+
## Setup
21+
22+
Magento 2 Open Source or Commerce edition is required.
23+
24+
### Composer installation
25+
26+
Run the following composer command:
27+
28+
```
29+
composer require opengento/module-document-search
30+
```
31+
32+
### Setup the module
33+
34+
Run the following magento command:
35+
36+
```
37+
bin/magento setup:upgrade
38+
```
39+
40+
**If you are in production mode, do not forget to recompile and redeploy the static resources.**
41+
42+
## Features
43+
44+
This module aims to make documents searchable for customers in Magento 2.
45+
Documents can be searchable if their visibility is set to `search`.
46+
47+
## Documentation
48+
49+
You can change the full search behavior by using the collection modifier extension point.
50+
Add you own `Magento\Framework\Data\CollectionModifierInterface` implementation to the modifiers list of:
51+
52+
`\Opengento\DocumentSearch\Model\Collection\CollectionModifier`
53+
54+
Query parameters can be read through: `\Opengento\DocumentSearch\Model\QueryData`
55+
56+
## Support
57+
58+
Raise a new [request](https://github.com/opengento/magento2-document-search/issues) to the issue tracker.
59+
60+
## Authors
61+
62+
- **Opengento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento)
63+
- **Thomas Klein** - *Maintainer* - [![GitHub followers](https://img.shields.io/github/followers/thomas-kl1.svg?style=social)](https://github.com/thomas-kl1)
64+
- **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)
65+
66+
## License
67+
68+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details.
69+
70+
***That's all folks!***

composer.json

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,54 @@
11
{
22
"name": "opengento/module-document-widget",
3-
"version": "1.0.0",
4-
"description": "N/A",
3+
"description": "This module aims to help merchants to manage easily their documents on the Magento 2 storefront.",
4+
"keywords": [
5+
"php",
6+
"magento",
7+
"magento2",
8+
"module",
9+
"extension",
10+
"document",
11+
"widget"
12+
],
513
"type": "magento2-module",
614
"require": {
715
"ext-dom": "*",
8-
"magento/framework": "*",
9-
"magento/module-widget": "*",
10-
"opengento/module-document": "*"
16+
"magento/framework": "^103.0",
17+
"magento/module-widget": "^101.0",
18+
"opengento/module-document": "^1.0"
1119
},
1220
"require-dev": {
1321
"magento/magento-coding-standard": "^5",
1422
"magento/marketplace-eqp": "^4.0",
1523
"roave/security-advisories": "dev-master"
1624
},
25+
"suggest": {
26+
"opengento/module-document-product-link": "",
27+
"opengento/module-document-product-search": "",
28+
"opengento/module-document-search": ""
29+
},
1730
"license": [
1831
"MIT"
1932
],
33+
"homepage": "https://github.com/opengento/magento2-document-widget",
34+
"authors": [
35+
{
36+
"name": "Opengento Team",
37+
"email": "[email protected]",
38+
"homepage": "https://opengento.fr/",
39+
"role": "lead"
40+
},
41+
{
42+
"name": "Thomas Klein",
43+
"email": "[email protected]",
44+
"homepage": "https://www.linkedin.com/in/thomas-klein/",
45+
"role": "maintainer"
46+
}
47+
],
48+
"support": {
49+
"source": "https://github.com/opengento/magento2-document-widget",
50+
"issues": "https://github.com/opengento/magento2-document-widget/issues"
51+
},
2052
"autoload": {
2153
"files": [
2254
"registration.php"

0 commit comments

Comments
 (0)