diff --git a/README.md b/README.md index 63a1cb15d..6b24b1dd0 100644 --- a/README.md +++ b/README.md @@ -50,32 +50,34 @@ npm run build ```sh $ preact create - --name directory and package name for the new app - --dest Directory to create the app within [default: ] - --type A project template to start from + --name directory and package name for the new app. + --dest Directory to create the app within. [default: ] + --type A project template to start from. [Options: "default", "root", "simple", "empty"] [default: "default"] - --less Pre-install LESS support [boolean] [default: false] - --sass Pre-install SASS/SCSS support [boolean] [default: false] - --git Initialize version control using git [boolean] [default: true] + --less Pre-install LESS support. [boolean] [default: false] + --sass Pre-install SASS/SCSS support. [boolean] [default: false] + --git Initialize version control using git. [boolean] [default: true] $ preact build - --src Entry file (index.js) [default: "src"] - --dest Directory root for output [default: "build"] + --src Entry file (index.js). [default: "src"] + --dest Directory root for output. [default: "build"] --production, -p Create a minified production build. [default: true] - --less, -l Build and compile LESS files [default: false] - --sass, -s Build and compile SASS files [default: false] + --less, -l Build and compile LESS files. [default: false] + --sass, -s Build and compile SASS files. [default: false] --prerender Pre-render static app content. [default: true] + --template Path to template file. --clean Clear output directory before building. [default: true] --json Generate build statistics for analysis. [default: false] --config, -c Path to custom CLI config. $ preact watch - --src Entry file (index.js) [default: "src"] - --port, -p Port to start a server on [default: "8080"] + --src Entry file (index.js). [default: "src"] + --port, -p Port to start a server on. [default: "8080"] --host [boolean] [default: "0.0.0.0"] - --prerender Pre-render static app content on initial build [default: false] + --prerender Pre-render static app content on initial build. [default: false] + --template Path to template file. $ preact serve @@ -83,9 +85,9 @@ $ preact serve --cwd The working directory in which to spawn a server. [default: .] --server Which server to run, or "config" to produce a firebase config. [options: "simplehttp2server", "superstatic", "config"] [default:"simplehttp2server"] - --dest Directory or filename where firebase.json should be written + --dest Directory or filename where firebase.json should be written. (used for --server config) [default: -] - --port, -p Port to start a server on [default: "8080"] + --port, -p Port to start a server on. [default: "8080"] ``` @@ -142,6 +144,18 @@ export default function (config, env, helpers) { ``` See [WebpackConfigHelpers] docs for more info on ```helpers``` argument. +#### Template +A template is used to render your page. + +The default one is visible [here](src/resources/template.html) and it's going to be enough for the majority of cases. + +If you want to customise your template you can pass a custom template with the `--template` flag. + +The `--template` flag is available on the `build` and `watch` commands. +``` +preact build --template src/template.html +preact watch --template src/template.html +``` [preact]: https://github.com/developit/preact [preact-router]: https://github.com/developit/preact-router