diff --git a/README.md b/README.md index 0f6abe2..fecc155 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,35 @@ # sapper-template -The default [Sapper](https://github.com/sveltejs/sapper) template, with branches for Rollup and webpack. To clone it and get started: +The default [Sapper](https://github.com/sveltejs/sapper) template, available for Rollup and webpack. + + +## Getting started + + +### Using `degit` + +[`degit`](https://github.com/Rich-Harris/degit) is a scaffolding tool that lets you create a directory from a branch in a repository. Use either the `rollup` or `webpack` branch in `sapper-template`: ```bash # for Rollup npx degit "sveltejs/sapper-template#rollup" my-app # for webpack npx degit "sveltejs/sapper-template#webpack" my-app +``` + + +### Using GitHub templates + +Alternatively, you can use GitHub's template feature with the [sapper-template-rollup](https://github.com/sveltejs/sapper-template-rollup) or [sapper-template-webpack](https://github.com/sveltejs/sapper-template-webpack) repositories. + + +### Running the project + +However you get the code, you can install dependencies and run the project in development mode with: + +```bash cd my-app -npm install # or yarn! +npm install # or yarn npm run dev ```