From 167898f31ba772b9ed9fd7ebcd04c5f7e08a31dc Mon Sep 17 00:00:00 2001 From: ray Date: Sat, 27 Mar 2021 18:31:23 +0000 Subject: [PATCH] update readme --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index cf6426f..5815925 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -October CMS Webpack Theme Boilerplate +# October CMS Webpack Theme Boilerplate + ========== This is a starter theme for October CMS that includes: @@ -9,20 +10,15 @@ This is a starter theme for October CMS that includes: To use it: -- [Install October CMS](https://octobercms.com/docs/setup/installation) -- Clone the repo in your theme directory -- Inside cloned directory run `npm install` (node_modules folder will be created) -- Install more packages using `npm install --save` -- Require your installed packages in src/js/app.js -- Modify the js and css files -- Run `npm run dev` (`npm run watch` to recompile when something changes, `npm run hot` to enable HMR) -- [Add new pages, partials, content files...](https://octobercms.com/docs/cms/themes) +- [Install October CMS](https://octobercms.com/docs/setup/installation). +- Clone the repo in October's `themes` directory. +- Inside cloned directory run `npm install`. +- Install more packages using `npm install --save`. +- Require your installed packages in `src/js/app.js`. +- Run `npm run dev` (`npm run watch` to recompile when something changes, `npm run hot` to enable HMR). +- Run `npm run prod` to compile for production. -When you are ready for production: - -- Run `npm run prod` - -## To add ajax framework +## To enable the Ajax framework ```sh npm install jquery