Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
godanny86 committed Sep 22, 2021
1 parent 927a610 commit 7e24e63
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# WKND Asset Share

This is a sample implementation of [Asset Share Commons](https://github.com/adobe/asset-share-commons) for the WKND brand. It includes Asset Share Commons via the `all` module. The `ui.frontend` module has been created based off of the out of the box Asset Share Commons [Light Theme](https://github.com/adobe/asset-share-commons/tree/develop/ui.frontend.theme.light) and modified to match the WKND Branding standards.
This is a sample implementation of [Asset Share Commons](https://github.com/adobe/asset-share-commons) for the WKND brand.

![WKND Asset Share Commons theme](https://user-images.githubusercontent.com/8974514/134435899-ac6f0b11-da30-40e4-b744-334d0b16758f.png)

It includes Asset Share Commons via the `all` module. The `ui.frontend` module has been created based off of the out of the box Asset Share Commons [Light Theme](https://github.com/adobe/asset-share-commons/tree/develop/ui.frontend.theme.light) and modified to match the WKND Branding standards.

## Documentation

Learn more about Asset Share Commons and how to create your own project: [https://opensource.adobe.com/asset-share-commons/](https://opensource.adobe.com/asset-share-commons/)

## How to use

Pre-compiled AEM packages are available under the latest release for easy installation on local environments using [CRX Package Manager](http://localhost:4502/crx/packmgr/index.jsp)
A pre-compiled AEM package is available under the latest release for easy installation on local environments using [CRX Package Manager](http://localhost:4502/crx/packmgr/index.jsp)

* [`wknd-asset-share.all-x.x.x.zip`](https://github.com/godanny86/wknd-asset-share/releases/latest): AEM as a Cloud Service, default build

* [`aem-guides-wknd.all-x.x.x.zip`](https://github.com/adobe/aem-guides-wknd/releases/latest): AEM as a Cloud Service, default build
It may also be helpful to install the full [WKND Sites project](https://github.com/adobe/aem-guides-wknd/releases/latest) or the [asset-share-commons.ui.content.sample-2.x.x.zip](https://github.com/adobe/asset-share-commons/releases/latest) so that you have some digital assets to work with.

## How to build

Expand All @@ -28,4 +34,4 @@ To build all the modules and deploy the `all` package to a local instance of AEM
------------------------|---------|---------
AEM as a Cloud Service only | 8, 11 | 3.3.9+

Setup your local development environment for [AEM as a Cloud Service SDK](https://experienceleague.adobe.com/docs/experience-manager-learn/cloud-service/local-development-environment-set-up/overview.html) or for [older versions of AEM](https://experienceleague.adobe.com/docs/experience-manager-learn/foundation/development/set-up-a-local-aem-development-environment.html).
Setup your local development environment for [AEM as a Cloud Service SDK](https://experienceleague.adobe.com/docs/experience-manager-learn/cloud-service/local-development-environment-set-up/overview.html).

0 comments on commit 7e24e63

Please sign in to comment.