From 58bba83ac62c427ae37f1c8401a411078a1e2159 Mon Sep 17 00:00:00 2001 From: Ola Date: Tue, 29 Mar 2022 10:53:38 +0200 Subject: [PATCH] wip --- README.md | 85 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 46 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 34590b707..c765c955a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,30 @@ -# Alpaca - components & theme for Magento 2.4 +div align="center"> +Alpaca Logo + +[![Latest Stable Version](http://poser.pugx.org/snowdog/theme-frontend-alpaca/v)](https://packagist.org/packages/snowdog/theme-frontend-alpaca) [![Total Downloads](http://poser.pugx.org/snowdog/theme-frontend-alpaca/downloads)](https://packagist.org/packages/snowdog/theme-frontend-alpaca)
+📚 [Docs](./docs) | 📝 [Changelog](./CHANGELOG.md)
+ +
+ +[Magento OS Demo](https://alpaca-community.snowdog.dev/) | [Magento Commerce Demo](https://alpaca-commerce.snowdog.dev/) | [Components Preview](https://magento2-alpaca-theme-git-master-snowdog1.vercel.app/)
+ + +# Magento 2 Theme Frontend Alpaca + +📝 Component-based +📚 Feature-rich +🎨 Themable +♿️ Accessible +💅 Polished + ## Migration guide for Alpaca theme >= 2.26.0 -`2.26.0` version includes a lot of changes and has different files structure, please go to [Migration Guide](.doc/MIGRATION_GUIDE.md) for more informations +`2.26.0` version includes a lot of changes and has different file structure, please go to [Migration Guide](.doc/MIGRATION_GUIDE.md) for more information Latest Alpaca version supports work with Magento 2.4.3.
-If you use lower Magento versionb, check the [Changelog file](../CHANGELOG.md) to decide which version to use.
. -## Description -Alpaca Theme for Magento 2 is part of a `alpaca-packages` -To make it work with all features, we use following modules: - -Open source +If you use lower Magento version, check the [Changelog file](./CHANGELOG.md) to decide which version to use.
+## Alpaca Packages +Alpaca Theme is a part of [Alpaca Packages](https://github.com/SnowdogApps/magento2-alpaca-packages) - a set of open source modules that cover Alpaca base features. +It includes: * [magepal/magento2-gmailsmtpapp](https://github.com/magepal/magento2-gmail-smtp-app) * [magepal/magento2-googletagmanager](https://github.com/magepal/magento2-google-tag-manager) * [mailchimp/mc-magento2](https://github.com/mailchimp/mc-magento2) @@ -23,31 +39,29 @@ Open source * [snowdog/module-wishlist-unlocker](https://github.com/SnowdogApps/magento2-wishlist-unlocker) * [webshopapps/module-matrixrate](https://github.com/webshopapps/module-matrixrate) -Alpaca supports also following OS modules: -* paradoxlabs/authnetcim -* paradoxlabs/tokenbase -* authorizenet/magento-module-creditcard -* [snowdog/module-alpaca-acm](https://github.com/SnowdogApps/magento2-alpaca-acm) - alpaca customisation for paid `blackbird/contentmanager` extension - -Additional, non-opensource modules the theme works with to cover additional features: -* amasty/adminactionslog -* amasty/module-gdpr -* amasty/module-gift-card -* amasty/module-google-rich-snippets -* amasty/module-product-feed -* amasty/module-shipping-rules -* amasty/module-special-promo -* amasty/module-store-locator -* amasty/payrestriction -* amasty/shiprestriction -* apptrian/facebook-pixel -* blackbird/contentmanager -* vladimirpopov/webforms - -## What Alpaca is? -Alpaca is a Magento 2 theme based on components system. +## Third-party module compatibility +Besides modules included in [Alpaca Packages](#alpaca-packages), Alpaca supports the following modules: +* Open source: + * paradoxlabs/authnetcim + * paradoxlabs/tokenbase + * authorizenet/magento-module-creditcard + * [snowdog/module-alpaca-acm](https://github.com/SnowdogApps/magento2-alpaca-acm) - Alpaca customisations for paid `blackbird/contentmanager` extension +* Non-open source modules the theme works with to cover additional features: + * amasty/adminactionslog + * amasty/module-gdpr + * amasty/module-gift-card + * amasty/module-google-rich-snippets + * amasty/module-product-feed + * amasty/module-shipping-rules + * amasty/module-special-promo + * amasty/module-store-locator + * amasty/payrestriction + * amasty/shiprestriction + * apptrian/facebook-pixel + * blackbird/contentmanager + * vladimirpopov/webforms -### Alpaca features: +### Key features * Components system, build with fractal as a separate tool, on which you can work outside of Magento. You can customise it with variables or change and overwrite whole components. * SVG icons - easily used also in CMS content * Menu build with [Snowdog Module Menu](https://github.com/SnowdogApps/magento2-menu) @@ -59,10 +73,3 @@ And much more. Check how to work with different features in [Working with Alpaca ## Installation Check [Alpaca installation step by step guide](./docs/alpaca-step-by-step.md) - -## Alpaca preview - -* [Alpaca components preview](https://magento2-alpaca-theme-git-master-snowdog1.vercel.app/) -* [Alpaca theme on Magento 2 Community](https://alpaca-community.snowdog.dev/) -* [Alpaca theme on Magento 2 Commerce](https://alpaca-commerce.snowdog.dev/) -