diff --git a/README.md b/README.md index b5b2950..2382d24 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,46 @@ -# sv +## Welcome -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +This site is a clean wrapper around Aviation weather APIs to allow desk pilots to pre-brief flights effectively! -## Creating a project +## Screenshots -If you're seeing this, you've probably already done this step. Congrats! +

+ + +

+ +## Getting Started + +Get starting but installing all of the dependencies of the project. ```bash -# create a new project in the current directory -npx sv create +npm install -# create a new project in my-app -npx sv create 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 created a project and installed dependencies with `pnpm install` (or `npm install` or `yarn`), start a development server: ```bash -npm run dev +pnpm run dev +``` + +```bash # or start the server and open the app in a new browser tab -npm run dev -- --open +pnpm run dev -- --open + ``` ## Building -To create a production version of your app: +To create a production version of the app: ```bash -npm run build +pnpm run build + + ``` -You can preview the production build with `npm run preview`. +You can preview the production build with `pnpm run preview`. -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. In this case, vite is used. diff --git a/assets/images/main-screen.png b/assets/images/main-screen.png new file mode 100644 index 0000000..1988ea1 Binary files /dev/null and b/assets/images/main-screen.png differ diff --git a/assets/images/main.png b/assets/images/main.png new file mode 100644 index 0000000..d4727c7 Binary files /dev/null and b/assets/images/main.png differ