-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #50 from BartoszWojdalowicz/bwojdalowicz/readme_up…
…date Readme update
- Loading branch information
Showing
1 changed file
with
134 additions
and
41 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 |
|---|---|---|
| @@ -1,48 +1,56 @@ | ||
| <h1 align="center"> | ||
| <a href="http://bitbag.shop" target="_blank"> | ||
| <img src="doc/logo.png" width="55%" /> | ||
| </a> | ||
| <br /> | ||
| <a href="https://packagist.org/packages/bitbag/wishlist-plugin" title="License" target="_blank"> | ||
| <img src="https://img.shields.io/packagist/l/bitbag/wishlist-plugin.svg" /> | ||
| </a> | ||
| <a href="https://packagist.org/packages/bitbag/wishlist-plugin" title="Version" target="_blank"> | ||
| <img src="https://img.shields.io/packagist/v/bitbag/wishlist-plugin.svg" /> | ||
| </a> | ||
| <a href="http://travis-ci.org/BitBagCommerce/SyliusWishlistPlugin" title="Build status" target="_blank"> | ||
| <img src="https://img.shields.io/travis/BitBagCommerce/SyliusWishlistPlugin/master.svg" /> | ||
| </a> | ||
| <a href="https://scrutinizer-ci.com/g/BitBagCommerce/SyliusWishlistPlugin/" title="Scrutinizer" target="_blank"> | ||
| <img src="https://img.shields.io/scrutinizer/g/BitBagCommerce/SyliusWishlistPlugin.svg" /> | ||
| </a> | ||
| <a href="https://packagist.org/packages/bitbag/wishlist-plugin" title="Total Downloads" target="_blank"> | ||
| <img src="https://poser.pugx.org/bitbag/wishlist-plugin/downloads" /> | ||
| </a> | ||
| <p> | ||
| <a href="https://sylius.com/plugins/" target="_blank"> | ||
| <img src="https://sylius.com/assets/badge-approved-by-sylius.png" width="85"> | ||
| </a> | ||
| </p> | ||
| </h1> | ||
|
|
||
| ## About us | ||
|
|
||
| At BitBag we do believe in open source. However, we are able to do it just beacuse of our awesome clients, who are kind enough to share some parts of our work with the community. Therefore, if you feel like there is a possibility for us working together, feel free to reach us out. You will find out more about our professional services, technologies and contact details at https://bitbag.io/. | ||
|
|
||
| ## BitBag SyliusWishlistPlugin | ||
| # [](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) | ||
|
|
||
| # BitBag SyliusWishlistPlugin | ||
|
|
||
| ---- | ||
|
|
||
| [ ](https://packagist.org/packages/bitbag/wishlist-plugin "License") [  ](https://packagist.org/packages/bitbag/wishlist-plugin "Version") [  ](http://travis-ci.org/BitBagCommerce/SyliusWishlistPlugin "Build status") [  ](https://scrutinizer-ci.com/g/BitBagCommerce/SyliusWishlistPlugin/ "Scrutinizer") [](https://packagist.org/packages/bitbag/wishlist-plugin "Total Downloads") [](http://sylius-devs.slack.com) [](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) | ||
|
|
||
| <p> | ||
| <img src="https://sylius.com/assets/badge-approved-by-sylius.png" width="85"> | ||
| </p> | ||
|
|
||
| At BitBag we do believe in open source. However, we are able to do it just because of our awesome clients, who are kind enough to share some parts of our work with the community. Therefore, if you feel like there is a possibility for us working together, feel free to reach us out. You will find out more about our professional services, technologies and contact details at [https://bitbag.io/](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist). | ||
|
|
||
| ## Table of Content | ||
|
|
||
| *** | ||
|
|
||
| * [Overview](#overwiev) | ||
| * [Support](#we-are-here-to-help) | ||
| * [Installation](#installation) | ||
| * [Usage](#usage) | ||
| * [Customization](#customization) | ||
| * [Testing](#testing) | ||
| * [About us](#about-us) | ||
| * [Community](#community) | ||
| * [Demo Sylius shop](#demo-sylius-shop) | ||
| * [Additional Sylius resources for developers](#additional-resources-for-developers) | ||
| * [License](#license) | ||
| * [Contact](#contact) | ||
|
|
||
| # Overview | ||
|
|
||
| ---- | ||
| This plugin allows you to integrate wishlist features with Sylius platform app. | ||
|
|
||
| ## Demo | ||
|
|
||
| We created a demo app with some useful use-cases of the plugin! Visit [demo.bitbag.shop](https://demo.bitbag.shop) to take a look at it. | ||
| The admin can be accessed under [demo.bitbag.shop/admin](https://demo.bitbag.shop/admin) link and `sylius: sylius` credentials. | ||
| ## We are here to help | ||
| This **open-source plugin was developed to help the Sylius community** and make Mollie payments platform available to any Sylius store. If you have any additional questions, would like help with installing or configuring the plugin or need any assistance with your Sylius project - let us know! | ||
|
|
||
| [](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) | ||
|
|
||
|
|
||
| ## Installation | ||
| # Installation | ||
|
|
||
| ---- | ||
|
|
||
|
|
||
| We work on stable, supported and up-to-date versions of packages. We recommend you to do the same. | ||
| ```bash | ||
| $ composer require bitbag/wishlist-plugin | ||
| ``` | ||
|
|
||
| Add plugin dependencies to your `config/bundles.php` file: | ||
| ```php | ||
| return [ | ||
|
|
@@ -87,19 +95,23 @@ $ bin/console doctrine:migrations:version BitBag\\SyliusWishlistPlugin\\Migratio | |
| ## Usage | ||
| ---- | ||
| ### Rendering the wishlist | ||
| <div align="center"> | ||
| <img src="doc/index.jpg" /> | ||
| <img src="doc/index.jpg"/> | ||
| </div> | ||
| You can use `@BitBagSyliusWishlistPlugin/_addToWishlist.html.twig`, `@BitBagSyliusWishlistPlugin/_removeFromWishlist.html.twig` and `@BitBagSyliusWishlistPlugin/_removeFromWishlist.html.twig` | ||
| templates to enable adding/removing/displaying wishlist from the Twig UI. | ||
| templates to enable adding/removing/displaying wishlist from the Twig UI. | ||
| For an example on how to do that, take a look at [these source files](https://github.com/BitBagCommerce/SyliusWishlistPlugin/tree/master/tests/Application/templates/bundles/SyliusShopBundle). | ||
| ## Customization | ||
| ---- | ||
| ### Available services you can [decorate](https://symfony.com/doc/current/service_container/service_decoration.html) and forms you can [extend](http://symfony.com/doc/current/form/create_form_type_extension.html) | ||
| Run the below command to see what Symfony services are shared with this plugin: | ||
|
|
@@ -114,6 +126,8 @@ $ bin/console debug:container --parameters | grep wishlist | |
| ``` | ||
|
|
||
| ## Testing | ||
| ---- | ||
|
|
||
| ```bash | ||
| $ composer install | ||
| $ cd tests/Application | ||
|
|
@@ -128,6 +142,85 @@ $ vendor/bin/behat | |
| $ vendor/bin/phpspec run | ||
| ``` | ||
|
|
||
| ## Contribution | ||
|
|
||
| Learn more about our contribution workflow on http://docs.sylius.org/en/latest/contributing/. | ||
|
|
||
| # About us | ||
|
|
||
| --- | ||
|
|
||
| BitBag is an agency that provides high-quality **eCommerce and Digital Experience software**. Our main area of expertise includes eCommerce consulting and development for B2C, B2B, and Multi-vendor Marketplaces. | ||
| The scope of our services related to Sylius includes: | ||
| - **Consulting** in the field of strategy development | ||
| - Personalized **headless software development** | ||
| - **System maintenance and long-term support** | ||
| - **Outsourcing** | ||
| - **Plugin development** | ||
| - **Data migration** | ||
|
|
||
| Some numbers regarding Sylius: | ||
| * **20+ experts** including consultants, UI/UX designers, Sylius trained front-end and back-end developers, | ||
| * **100+ projects** delivered on top of Sylius, | ||
| * Clients from **20+ countries** | ||
| * **3+ years** in the Sylius ecosystem. | ||
|
|
||
| --- | ||
|
|
||
| If you need some help with Sylius development, don't be hesitate to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) or send us an e-mail to [email protected]! | ||
|
|
||
| --- | ||
|
|
||
| [](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) | ||
|
|
||
| ## Community | ||
|
|
||
| ---- | ||
| For online communication, we invite you to chat with us & other users on [Sylius Slack](https://sylius-devs.slack.com/). | ||
|
|
||
| # Demo Sylius shop | ||
|
|
||
| --- | ||
|
|
||
| We created a demo app with some useful use-cases of plugins! | ||
| Visit b2b.bitbag.shop to take a look at it. The admin can be accessed under b2b.bitbag.shop/admin/login link and sylius: sylius credentials. | ||
| Plugins that we have used in the demo: | ||
|
|
||
| | BitBag's Plugin | GitHub | Sylius' Store| | ||
| | ------ | ------ | ------| | ||
| | ACL Plugin | *Private. Available after the purchasing.*| https://plugins.sylius.com/plugin/access-control-layer-plugin/| | ||
| | Braintree Plugin | https://github.com/BitBagCommerce/SyliusBraintreePlugin |https://plugins.sylius.com/plugin/braintree-plugin/| | ||
| | CMS Plugin | https://github.com/BitBagCommerce/SyliusCmsPlugin | https://plugins.sylius.com/plugin/cmsplugin/| | ||
| | Elasticsearch Plugin | https://github.com/BitBagCommerce/SyliusElasticsearchPlugin | https://plugins.sylius.com/plugin/2004/| | ||
| | Mailchimp Plugin | https://github.com/BitBagCommerce/SyliusMailChimpPlugin | https://plugins.sylius.com/plugin/mailchimp/ | | ||
| | Multisafepay Plugin | https://github.com/BitBagCommerce/SyliusMultiSafepayPlugin | | ||
| | Wishlist Plugin | https://github.com/BitBagCommerce/SyliusWishlistPlugin | https://plugins.sylius.com/plugin/wishlist-plugin/| | ||
| | **Sylius' Plugin** | **GitHub** | **Sylius' Store** | | ||
| | Admin Order Creation Plugin | https://github.com/Sylius/AdminOrderCreationPlugin | https://plugins.sylius.com/plugin/admin-order-creation-plugin/ | | ||
| | Invoicing Plugin | https://github.com/Sylius/InvoicingPlugin | https://plugins.sylius.com/plugin/invoicing-plugin/ | | ||
| | Refund Plugin | https://github.com/Sylius/RefundPlugin | https://plugins.sylius.com/plugin/refund-plugin/ | | ||
|
|
||
| **If you need an overview of Sylius' capabilities, schedule a consultation with our expert.** | ||
|
|
||
| [](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) | ||
|
|
||
| ## Additional resources for developers | ||
|
|
||
| --- | ||
| To learn more about our contribution workflow and more, we encourage ypu to use the following resources: | ||
| * [Sylius Documentation](https://docs.sylius.com/en/latest/) | ||
| * [Sylius Contribution Guide](https://docs.sylius.com/en/latest/contributing/) | ||
| * [Sylius Online Course](https://sylius.com/online-course/) | ||
|
|
||
| ## License | ||
|
|
||
| --- | ||
|
|
||
| This plugin's source code is completely free and released under the terms of the MIT license. | ||
|
|
||
| [//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.) | ||
|
|
||
| ## Contact | ||
|
|
||
| --- | ||
| If you want to contact us, the best way is to fill the form on [our website](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) or send us an e-mail to [email protected] with your question(s). We guarantee that we answer as soon as we can! | ||
|
|
||
| [](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_wishlist) | ||