Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Mesuva committed Nov 23, 2021
1 parent ef4d4d6 commit 5f216ff
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

An open, free and community developed eCommerce system for concrete5
An open, free and community developed eCommerce system for Concrete CMS (previously known as concrete5)

Please refer to the project documentation for extended details - https://concrete5-community-store.github.io/community_store/
Please refer to the project documentation for extended details - https://**concrete**5-community-store.github.io/community_store/

The goal of this project is to provide a stable, feature rich, highly extensible and customizable 'shopping cart toolkit' for version 8+ of concrete5.
The goal of this project is to provide a stable, feature rich, highly extensible and customizable 'shopping cart toolkit' for version 8+ of Concrete CMS.
The add-on will work directly with a Bootstrap based theme, primarily Elemental, but is intended to be easily modified and overriden for a custom theme.

## PHP Version
This add-on is intended to be run in a PHP 7 environment.

## Concrete CMS Version
Version 2.4.3 and beyond of Community Store is intended for use with version 9 and version 8 of Concrete CMS.
Earlier releases of Community Store will not work or display correctly under version 9 of Concrete. If you are updating an existing version 8 install of Concrete with Community Store installed, please upgrade Community Store to version 2.4.3 or later.

## Setup
The package can be downloaded, unzipped into the /packages directory (ensuring the folder name is simply 'community_store') and installed via the 'Extend concrete5' option within the dashboard. It is recommended that a 'release' be used instead of the master branch - https://github.com/concrete5-community-store/community_store/releases
The package can be downloaded, unzipped into the /packages directory (ensuring the folder name is simply 'community_store') and installed via the 'Extend Concrete' option within the dashboard. It is recommended that a 'release' be used instead of the master branch - https://github.com/concrete5-community-store/community_store/releases

## Development
To install dependencies run:
Expand Down Expand Up @@ -41,7 +45,7 @@ https://github.com/concrete5-community-store/community_store_shipping_example
Further pre-built shipping methods are also available at Additional gateways can be found at https://github.com/concrete5-community-store.

## Translations
Interface translations for Community Store are managed at https://translate.concrete5.org/translate/package/community_store and can be installed via concrete5's dashboard.
Interface translations for Community Store are managed at https://translate.concretecms.org/translate/package/community_store and can be installed via Concrete's dashboard.

To provide translations, please register/login at the above link.

Expand All @@ -53,7 +57,7 @@ https://github.com/JeRoNZ/community_store_order_history

### Omni Gallery for Community Store
Show product and product list images in galleries, sliders and carousels.
https://www.concrete5.org/marketplace/addons/omni-gallery-for-community-store
https://marketplace.concretecms.com/marketplace/addons/omni-gallery-for-community-store

### Community Store Import
Import products via a CSV file.
Expand Down

0 comments on commit 5f216ff

Please sign in to comment.