From b6fd5eaa66292d7c581e0d778dc065c777a6f268 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Mon, 23 Dec 2024 12:37:12 -0600 Subject: [PATCH] feat: update readme --- README.md | 18 ++++----------- packages/website/README.md | 47 -------------------------------------- 2 files changed, 4 insertions(+), 61 deletions(-) delete mode 100644 packages/website/README.md diff --git a/README.md b/README.md index fb20f6371..8c4632518 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,13 @@ -## Visit the website +## BlitzKit + +Your premier source for all things Blitz. ### https://blitzkit.app/ -![BlitzKit website](https://i.imgur.com/m8e39Rv.png) - -# BlitzKit - -[![built with Codeium](https://codeium.com/badges/main)](https://codeium.com) - -Tools for everything World of Tanks Blitz +![BlitzKit website](https://i.imgur.com/KaxUxmt.png) ## Invite the bot Go to [application directory for BlitzKit](https://discord.com/application-directory/1097673957865443370) and click "Add to Server." Voila! You're ready to go. ![BlitzKit application directory](https://i.imgur.com/YWCtOuJ.png) - -## Visit the documentation website - -### https://tresabhi.github.io/blitzkit/ - -![BlitzKit documentation website](https://i.imgur.com/hm3KTsF.png) diff --git a/packages/website/README.md b/packages/website/README.md deleted file mode 100644 index e34a99b44..000000000 --- a/packages/website/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# Astro Starter Kit: Minimal - -```sh -npm create astro@latest -- --template minimal -``` - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json) - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! - -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json -``` - -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. - -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. - -Any static assets, like images, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | - -## 👀 Want to learn more? - -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).