Merge pull request #10 from cobraguy/rewrite

Update to Svelte app

1 files changed, 31 insertions, 14 deletions

diff --git a/README.md b/README.md
index 4771c74..d3b9f52 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,41 @@
-# pt-database-app
+## Get started
 
-## Project setup
-```
+Install the dependencies...
+
+```bash
+cd svelte-app
 npm install
 ```
 
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
+...then start [Rollup](https://rollupjs.org):
 
-### Compiles and minifies for production
+```bash
+npm run dev
 ```
+
+Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
+
+By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
+
+If you're using [Visual Studio Code](https://code.visualstudio.com/) we recommend installing the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.
+
+## Building and running in production mode
+
+To create an optimised version of the app:
+
+```bash
 npm run build
 ```
 
-### Lints and fixes files
-```
-npm run lint
-```
+You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).
+
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## Single-page app mode
+
+By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
+
+If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for *any* path. You can make it so by editing the `"start"` command in package.json:
+
+```js
+"start": "sirv public --single"
+```