diff --git a/README.md b/README.md index fb797b6ad0..5b0d9ef44c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,14 @@ Your project's description... - Preview: https://main--{repo}--{owner}.aem.page/ - Live: https://main--{repo}--{owner}.aem.live/ +## Documentation + +Before using the aem-boilerplate, we recommand you to go through the documentation on https://www.aem.live/docs/ and more specifically: +1. [Developer Tutorial](https://www.aem.live/developer/tutorial) +2. [The Anatomy of a Project](https://www.aem.live/developer/anatomy-of-a-franklin-project) +3. [Web Performance](https://www.aem.live/developer/keeping-it-100) +4. [Markup, Sections, Blocks, and Auto Blocking](https://www.aem.live/developer/markup-sections-blocks) + ## Installation ```sh @@ -23,4 +31,4 @@ npm run lint 1. Add the [AEM Code Sync GitHub App](https://github.com/apps/aem-code-sync) to the repository 1. Install the [AEM CLI](https://github.com/adobe/helix-cli): `npm install -g @adobe/aem-cli` 1. Start AEM Proxy: `aem up` (opens your browser at `http://localhost:3000`) -1. Open the `{repo}` directory in your favorite IDE and start coding :) +1. Open the `{repo}` directory in your favorite IDE and start coding :) \ No newline at end of file