From 65e5939d8f2233147877f610fda16f08a573d235 Mon Sep 17 00:00:00 2001 From: Alex Hewitson Date: Sat, 3 Jul 2021 11:58:40 +0100 Subject: [PATCH] Updated README --- README.md | 78 +++---------------------------------------------------- 1 file changed, 4 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 7b1ba83..288380a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,9 @@ -*Looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)* + +

Pocus

---- - -# svelte app - -This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template. - -To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit): - -```bash -npx degit sveltejs/template svelte-app -cd svelte-app -``` - -*Note that you will need to have [Node.js](https://nodejs.org) installed.* +## Description +Pocus is a pomodoro timer used for time management and encouraging egular breaks from work to ensure productivity. Pocus uses a minimalistic UI to remove distraction and offers basic settings to configure it to your needs. ## Get started @@ -44,62 +33,3 @@ To create an optimised version of the app: ```bash npm run build ``` - -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). - - -## 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" -``` - -## Using TypeScript - -This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with: - -```bash -node scripts/setupTypeScript.js -``` - -Or remove the script via: - -```bash -rm scripts/setupTypeScript.js -``` - -## Deploying to the web - -### With [Vercel](https://vercel.com) - -Install `vercel` if you haven't already: - -```bash -npm install -g vercel -``` - -Then, from within your project folder: - -```bash -cd public -vercel deploy --name my-project -``` - -### With [surge](https://surge.sh/) - -Install `surge` if you haven't already: - -```bash -npm install -g surge -``` - -Then, from within your project folder: - -```bash -npm run build -surge public my-project.surge.sh -```