From f9569b7a597b1a87b2806b0eb6bfd650767b796e Mon Sep 17 00:00:00 2001 From: Henk Verlinde Date: Mon, 21 Feb 2022 16:39:24 +0100 Subject: [PATCH] meta: update readme --- README.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 99066e4..daaffd7 100644 --- a/README.md +++ b/README.md @@ -72,9 +72,15 @@ Nine main reasons why you should use Doks: ## Requirements -Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts: +- [Git](https://git-scm.com/) — latest source release +- [Node.js](https://nodejs.org/) — latest LTS version or newer -- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. +
+Why Node.js? + +Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts. + +
## Get started @@ -82,25 +88,35 @@ Start a new Doks project in three steps: ### 1. Create a new site -Doks is available as a child theme, and a starter theme: +Doks is available as a child theme and a starter theme. -- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. -- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. +#### Child theme -Not quite sure? Use the Doks child theme. - -#### Doks child theme +- Intended for novice to intermediate users +- Intended for minor customizations +- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks) ```bash git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site ``` -#### Doks starter theme +#### Starter theme + +- Intended for intermediate to advanced users +- Intended for major customizations +- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) ```bash git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site ``` +
+Help me choose + +Not sure which one is for you? Pick the child theme. + +
+ ### 2. Install dependencies ```bash