Skip to content

Commit 0258690

Browse files
Update readme
1 parent 68cf02b commit 0258690

File tree

1 file changed

+190
-22
lines changed

1 file changed

+190
-22
lines changed

README.md

Lines changed: 190 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,98 @@
1-
# Magento2 Akeneo Bundle
2-
3-
This Magento2 extension made by [JustBetter](https://justbetter.nl) extends the official [Akeneo Connector](https://github.com/akeneo/magento2-connector-community) with several features and optimizations.
1+
<h1>JustBeter - Magento 2 Akeneo Bundle</h1>
2+
<a id="readme-top"></a>
3+
4+
[![Contributors][contributors-shield]][contributors-url]
5+
[![Forks][forks-shield]][forks-url]
6+
[![Stargazers][stars-shield]][stars-url]
7+
[![Issues][issues-shield]][issues-url]
8+
[![GPL-3.0 License][license-shield]][license-url]
9+
10+
<br />
11+
<div align="center">
12+
<a href="https://justbetter.nl">
13+
<img src="https://raw.githubusercontent.com/justbetter/art/master/justbetter-logo.png" alt="Logo" width="200">
14+
</a>
15+
16+
<h3 align="center">JustBeter - Magento 2 Akeneo Bundle</h3>
17+
18+
<p align="center">
19+
Powerful extensions for the Akeneo Connector Community Edition
20+
<br />
21+
<a href="https://github.com/justbetter/magento2-akeneo-bundle/issues">Report Bug</a>
22+
·
23+
<a href="https://github.com/justbetter/magento2-akeneo-bundle/issues">Request Feature</a>
24+
</p>
25+
</div>
26+
27+
<details>
28+
<summary>Table of Contents</summary>
29+
<ol>
30+
<li>
31+
<a href="#about-the-project">About The Project</a>
32+
<ul>
33+
<li><a href="#built-with">Built With</a></li>
34+
</ul>
35+
</li>
36+
<li>
37+
<a href="#getting-started">Getting Started</a>
38+
<ul>
39+
<li><a href="#prerequisites">Prerequisites</a></li>
40+
<li><a href="#installation">Installation</a></li>
41+
</ul>
42+
</li>
43+
<li><a href="#features">Features</a></li>
44+
<li><a href="#configuration">Configuration</a></li>
45+
<li><a href="#usage">Usage</a></li>
46+
<li><a href="#events">Events</a></li>
47+
<li><a href="#contributing">Contributing</a></li>
48+
<li><a href="#license">License</a></li>
49+
<li><a href="#contact">Contact</a></li>
50+
</ol>
51+
</details>
52+
53+
## About The Project
54+
55+
This Magento 2 extension made by [JustBetter](https://justbetter.nl) extends the official [Akeneo Connector](https://github.com/akeneo/magento2-connector-community) with several features and optimizations.
456

557
These features can be enabled / disabled via an extra configuration section called `JustBetter Akeneo` that is added to the default Akeneo Connector Configuration in Magento.
658

59+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
60+
61+
### Built With
62+
63+
* [![PHP][PHP-badge]][PHP-url]
64+
* [![Magento][Magento-badge]][Magento-url]
65+
* [![Akeneo][Akeneo-badge]][Akeneo-url]
66+
67+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
68+
69+
## Getting Started
70+
71+
### Prerequisites
72+
73+
* PHP >=8.2 <=8.4
74+
* Magento 2.4.4+
75+
* Akeneo Connector Community Edition
76+
77+
### Installation
78+
79+
1. Install via Composer
80+
```sh
81+
composer require justbetter/magento2-akeneo-bundle
82+
```
83+
84+
2. Enable the module
85+
```sh
86+
bin/magento module:enable JustBetter_AkeneoBundle
87+
```
88+
89+
3. Run setup upgrade and flush cache
90+
```sh
91+
bin/magento setup:upgrade && bin/magento cache:flush
92+
```
93+
94+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
95+
796
## Features
897

998
| Feature | Description |
@@ -25,8 +114,65 @@ These features can be enabled / disabled via an extra configuration section call
25114
| <a href="#not-visible-individually">Set families to not visible individually after importing</a> | Sets products in selected families to `Not Visible Individually` |
26115
| Unset Website when empty Product Attribute Mapping | When enabled this will unset the website from the product when a required attribute has no specific value. For example when the Name attribute in Akeneo is empty for the associated website |
27116
| Slack Akeneo import notifications | Setup Slack notifications of Akeneo imports |
28-
| <a href="#import-finished-events">Import finished events</a> | Fires an event for every job that is fully finished | |
29-
| Exclude Families from Import | Allows you to exclude specific families from being imported from Akeneo. _(Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo)_ | |
117+
| <a href="#import-finished-events">Import finished events</a> | Fires an event for every job that is fully finished |
118+
| Exclude Families from Import | Allows you to exclude specific families from being imported from Akeneo. _(Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo)_ |
119+
120+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
121+
122+
## Configuration
123+
124+
- Enable and disable different Akeneo features. Go to `Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo`.
125+
- To map specific Akeneo attribute code with a Magento Customer group. Simply go to `Stores > Configuration > Catalog > Akeneo Connector > Products > Customer Group Pricing`
126+
- When you would like to use the Tax Class Mapping: map the Akeneo Attribute Option Codes to the Magento Tax Classes. Don't forget to define the Tax attribute within the Attribute configuration for this feature to work.
127+
128+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
129+
130+
## Usage
131+
132+
### Metric Units
133+
<a id="metric-units"></a>
134+
135+
When enabled the default metric unit for metric attributes will be added to the `unit` field in the `eav_attribute` table.
136+
This can be overridden at a channel, currently we only support one channel for this which is configurable in the backend.
137+
138+
You can run this from the command line using:
139+
```sh
140+
bin/magento metric:import
141+
```
142+
143+
It is also automatically run after the attribute import.
144+
145+
### Family - Not Visible Individually
146+
<a id="not-visible-individually"></a>
147+
148+
If you need to set the visibility of all products that belong to certain families to `Not Visible Individually` you can select those families.
149+
After each import this will run and set products to not visible.
150+
151+
You can also run this from the command line using:
152+
```sh
153+
bin/magento akeneo:setfamilynotvisible
154+
```
155+
156+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
157+
158+
## Events
159+
<a id="import-finished-events"></a>
160+
161+
We added a total of 5 events:
162+
```
163+
akeneo_connector_import_finish_category
164+
akeneo_connector_import_finish_family
165+
akeneo_connector_import_finish_attribute
166+
akeneo_connector_import_finish_option
167+
akeneo_connector_import_finish_product
168+
```
169+
170+
These events are fired before the `cleanCache` function which only runs at the end of the job execution.
171+
That way the cache will still be flushed after your hook.
172+
173+
> **Note:** Please keep in mind that the Akeneo Products Import is executed per family ([since 102.1.1](https://github.com/akeneo/magento2-connector-community/blob/master/CHANGELOG.md#version-10211-)). So if you import products from multiple families the `akeneo_connector_import_finish_product` event will be called multiple times.
174+
175+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
30176

31177
## Installation
32178
```
@@ -52,31 +198,53 @@ akeneo_connector_import_finish_product
52198
These events are fired before the `cleanCache` function which only runs at the end of the job execution.
53199
That way the cache will still be flushed after your hook.
54200

55-
*Please keep in mind that the Akeneo Products Import is executed per family ([since 102.1.1](https://github.com/akeneo/magento2-connector-community/blob/master/CHANGELOG.md#version-10211-)). So if you import products from multiple families the `akeneo_connector_import_finish_product` event will be called multiple times.*
56201

57-
## Metric Units
58-
When enabled the default metric unit for metric attributes will be added to the `unit` field in the `eav_attribute` table.
59-
This can be overridden at a channel, currently we only support one channel for this which is configurable in the backend.
202+
> **Note:** Please keep in mind that the Akeneo Products Import is executed per family ([since 102.1.1](https://github.com/akeneo/magento2-connector-community/blob/master/CHANGELOG.md#version-10211-)). So if you import products from multiple families the `akeneo_connector_import_finish_product` event will be called multiple times.
60203
61-
You can run this from the command line using `bin/magento metric:import`
204+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
62205

63-
It is also automatically run after the attribute import
206+
## Contributing
64207

65-
## Family - Not Visible Individually
66-
If you need to set the visibility of all products that belong to certain families to `Not Visible Individually` you can select those families.
67-
After each import this will run and set products to not visible.
208+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
68209

69-
You can also run this from the command line using `bin/magento akeneo:setfamilynotvisible`
210+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
211+
Don't forget to give the project a star! Thanks again!
70212

71-
## Ideas, bugs or suggestions?
72-
It would be awesome if you can submit an [issue](https://github.com/justbetter/magento2-akeneo-bundle/issues) if you encounter any problems or for kudos create a [pull request](https://github.com/justbetter/magento2-akeneo-bundle/pulls).
213+
1. Fork the Project
214+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
215+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
216+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
217+
5. Open a Pull Request
73218

74-
## About us
75-
We are an innovative development agency from The Netherlands building awesome websites, webshops and web applications with Laravel and Magento2. Check out our website [justbetter.nl](https://justbetter.nl) and our [open source projects](https://github.com/justbetter).
219+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
76220

77221
## License
78-
[GNU GENERAL PUBLIC LICENSE](LICENSE)
79222

80-
---
223+
Distributed under the GPL-3.0 License. See `LICENSE` for more information.
224+
225+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
226+
227+
## Contact
228+
229+
[JustBetter B.V.](https://justbetter.nl/)
230+
231+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
232+
233+
<!-- MARKDOWN LINKS & IMAGES -->
234+
[contributors-shield]: https://img.shields.io/github/contributors/justbetter/magento2-akeneo-bundle.svg?style=for-the-badge
235+
[contributors-url]: https://github.com/justbetter/magento2-akeneo-bundle/graphs/contributors
236+
[forks-shield]: https://img.shields.io/github/forks/justbetter/magento2-akeneo-bundle.svg?style=for-the-badge
237+
[forks-url]: https://github.com/justbetter/magento2-akeneo-bundle/network/members
238+
[stars-shield]: https://img.shields.io/github/stars/justbetter/magento2-akeneo-bundle.svg?style=for-the-badge
239+
[stars-url]: https://github.com/justbetter/magento2-akeneo-bundle/stargazers
240+
[issues-shield]: https://img.shields.io/github/issues/justbetter/magento2-akeneo-bundle.svg?style=for-the-badge
241+
[issues-url]: https://github.com/justbetter/magento2-akeneo-bundle/issues
242+
[license-shield]: https://img.shields.io/github/license/justbetter/magento2-akeneo-bundle.svg?style=for-the-badge
243+
[license-url]: https://github.com/justbetter/magento2-akeneo-bundle/blob/master/LICENSE
81244

82-
<a href="https://justbetter.nl" title="JustBetter"><img src="https://raw.githubusercontent.com/justbetter/art/master/justbetter-logo.png" width="200px" alt="JustBetter logo"></a>
245+
[PHP-badge]: https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white
246+
[PHP-url]: https://www.php.net/
247+
[Magento-badge]: https://img.shields.io/badge/Magento-EE672F?style=for-the-badge&logo=magento&logoColor=white
248+
[Magento-url]: https://business.adobe.com/products/magento/magento-commerce.html
249+
[Akeneo-badge]: https://img.shields.io/badge/Akeneo-7C1B8A?style=for-the-badge&logo=akeneo&logoColor=white
250+
[Akeneo-url]: https://www.akeneo.com/

0 commit comments

Comments
 (0)