diff --git a/README.md b/README.md index 5c91169..b06a122 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,32 @@ -# create-svelte +# printer manager front-end -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +@todo: update readme with all features, and how to use it -## Creating a project -If you're seeing this, you've probably already done this step. Congrats! +Everything you need to build the Printer Manager front-end, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). -```bash -# create a new project in the current directory -npm create svelte@latest +The printer manager front-end is a web application that allows users to do printer actions through one webbrowser. + +Features: +- It loads the printers from the printer manager backend +- List available printers + - View temperatures + - View printer state +- View printer queue +- View printer files +- Upload files to the printer +- Delete files from the printer +- Start jobs +- Pause jobs +- Clear queue -# create a new project in my-app -npm create svelte@latest my-app -``` ## Developing -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +Once you've installed the project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: ```bash npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open ``` ## Building @@ -31,8 +35,4 @@ To create a production version of your app: ```bash npm run build -``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +``` \ No newline at end of file