Skip to content

Commit

Permalink
chore: Update and adjust readme and composer.json meta data
Browse files Browse the repository at this point in the history
  • Loading branch information
mitelg committed Jun 3, 2024
1 parent dee34c4 commit 2be0e59
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 37 deletions.
40 changes: 14 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,8 @@
![Shopware 5 collage](https://assets.shopware.com/media/github/shopware5_readme.png)

Shopware 5 is an open source e-commerce software made in Germany.
Based on technologies like `Symfony 4`, `Doctrine 2` & `Zend Framework` Shopware comes as the perfect platform for your next e-commerce project.
Furthermore, Shopware 5 provides an event-driven plugin system and an advanced hook system, giving you the ability to customize every part of the platform.

Visit the forum at <https://forum.shopware.com/>
Based on technologies like `Symfony 4`, `Doctrine 2` & `Zend Framework` Shopware comes as the perfect platform for your e-commerce project.
Furthermore, Shopware 5 provides an event-driven plugin system and an advanced hook system, giving you the ability to customize nearly every part of the platform.

----

Expand Down Expand Up @@ -58,7 +56,7 @@ Follow the instruction below if you want to install Shopware 5 using Git.
git clone https://github.com/shopware5/shopware.git

In case you wish to contribute to Shopware, fork the `5.7` branch rather than cloning it, and create a pull request via GitHub.
For further information please read the section "Get involved" of this document.
For further information please read the section ["Get involved"](#get-involved) of this document.

2.) Set the correct directory permissions:

Expand Down Expand Up @@ -90,23 +88,18 @@ Go to the root directory of your shopware system and download the test images:

wget -O test_images.zip http://releases.shopware.com/test_images_since_5.1.zip

For older Shopware versions < 5.1

wget -O test_images.zip http://releases.shopware.com/test_images.zip

Unzip the files inside the root directory:

unzip test_images.zip

You can now access your shop
You can now access your shop.
The test_images.zip file also includes thumbnails for the responsive theme.

# Backend

The backend is located at `/backend` example `http://your.shop.com/backend`.
Backend Login: demo/demo

The test_images.zip file includes thumbnails for the new responsive theme and the old deprecated template.

If you want to have full-featured demo data, you should download the respective demo data plugin in the First Run Wizard or in the Plugin Manager.

# Frontend users in demo data
Expand All @@ -116,37 +109,32 @@ If you want to have full-featured demo data, you should download the respective

# Get involved

Shopware is available under dual license (AGPL v3 and proprietary license).
Shopware is available under GPL v3 license.
If you want to contribute code (features or bugfixes), you have to create a pull request and include valid license information.
You can either contribute your code under New BSD or MIT license.

If you want to contribute to the backend part of Shopware, and your changes affect or are based on ExtJS code, they must be licensed under GPL V3, as per license requirements from Sencha Inc.

If you are not sure which license to use, or want more details about available licensing or the contribution agreements we offer, you can contact us at <[email protected]>.

For more information about contributing to Shopware, please see [CONTRIBUTING.md](CONTRIBUTING.md).


### How to report bugs / request features?

We've always had a sympathetic ear for our community, so please feel free to submit tickets with bug reports or feature requests.
In order to have a single issue tracking tool, we've decided to close the GitHub issue panel in favor of our Jira issue tracker, which is directly connected to our development division.

* [Shopware ticket submit form](https://issues.shopware.com/createissue)
We've always had an ear for our community, so please feel free to submit issues with bug reports or feature requests.
Just create a new issue [here](https://github.com/shopware5/shopware/issues) using the respective templates.

# Copying / License

Shopware is distributed under a dual license (AGPL v3 and proprietary license). You can find the whole license text in the `license.txt` file.
Shopware is distributed under the AGPL v3.
You can find the whole license text in the [license.txt](license.txt) file.

# Changelog

The changelog and all available commits are located under <https://github.com/shopware5/shopware>.
The changelog and all available commits can be found [here](https://github.com/shopware5/shopware/releases).

## Further reading

* [Shopware AG](https://www.shopware.com) - Homepage of shopware AG
* [Shopware Developer Documentation](https://developers.shopware.com/)
* [Shopware Docs](https://docs.shopware.com/) - Shopware documentation
* [Shopware Forum](https://forum.shopware.com) - Community forum
* [Shopware Marketplace](https://store.shopware.com) - Shopware Store
* [Shopware on Crowdin](https://crowdin.com/project/shopware) - Crowdin (Translations)
* [Shopware User Documentation](https://docs.shopware.com/en/shopware-5-en)
* [Shopware Community Forum](https://forum.shopware.com/c/shopware-5/7)
* [Shopware Store](https://store.shopware.com)
17 changes: 6 additions & 11 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
{
"name": "shopware/shopware",
"description": "Shopware is the next generation of open source e-commerce software made in Germany",
"description": "Shopware 5 is an open source e-commerce software made in Germany",
"keywords": ["shopware", "shop"],
"homepage": "https://www.shopware.com",
"homepage": "https://github.com/shopware5",
"type": "project",
"license": [
"AGPL-3.0",
"proprietary"
"AGPL-3.0"
],
"support": {
"forum": "https://forum.shopware.com",
"forum": "https://forum.shopware.com/c/shopware-5/7",
"chat": "https://slack.shopware.com",
"wiki": "https://developers.shopware.com/",
"source": "https://github.com/shopware5/shopware",
"issues": "https://issues.shopware.com"
"issues": "https://github.com/shopware5/shopware/issues"
},
"require": {
"php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
Expand Down Expand Up @@ -169,11 +168,7 @@
}
},
"scripts": {
"cs-check": "make check-php-cs-fixer",
"cs-fix": "make fix-code-style",
"post-install-cmd": "./build/composer-post-install-cmd.sh",
"post-update-cmd": "./build/composer-post-update-cmd.sh",
"test": "phpunit -c tests/ --colors=always",
"test-unit": "phpunit -c tests/phpunit_unit.xml.dist --colors=always"
"post-update-cmd": "./build/composer-post-update-cmd.sh"
}
}

0 comments on commit 2be0e59

Please sign in to comment.