Skip to content

Commit

Permalink
chore: new readme for website
Browse files Browse the repository at this point in the history
  • Loading branch information
Eveeifyeve committed Apr 13, 2024
1 parent f364533 commit 6e5fc55
Showing 1 changed file with 19 additions and 37 deletions.
56 changes: 19 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,35 @@
<h3 align="center">TeaClient Offical Website</h3>
<p align="center">A website for an open-sourced client</p>
<div align="center">
<img src="https://github-production-user-asset-6210df.s3.amazonaws.com/88671402/322197939-3d75a673-c273-452a-85bf-110ac423f46e.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240413%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240413T100638Z&X-Amz-Expires=300&X-Amz-Signature=30c8bf977ebb3611d66fc2ec663dd612c0607afe0e536d41e4e9a133d4557319&X-Amz-SignedHeaders=host&actor_id=88671402&key_id=0&repo_id=669430901" alt="Image of the website" width="500" height="300"/>
<h3>TeaClient Offical Website</h3>
<p>A website for an open-sourced client</p>

---

[![Deploy Website](https://github.com/TeaClientMC/Website/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/TeaClientMC/Website/actions/workflows/deploy.yml)
[![Stars](https://img.shields.io/github/stars/teaclientmc/website?style=for-the-badge&logo=starship&color=7d1fdb&logoColor=D9E0EE&labelColor=573422)](https://github.com/TeaClientMC/Website/pulls)
[![Issues](https://img.shields.io/github/issues/teaclientmc/website?style=for-the-badge&logo=gitbook&color=7d1fdb&logoColor=D9E0EE&labelColor=573422)](https://github.com/TeaClientMC/Website/issues)
</div>

<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/profile/dividers.png">
<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/assets/dividers.png" alt="divider">

## πŸš€ Project Structure
# Features
- News Articles
- Tempaltes with Layouts
- Uses frameworks that you love like Astro & Tailwind.

Inside of your Astro project, you'll see the following folders and files:
## Table of Contents

```text
/
β”œβ”€β”€ public/
β”œβ”€β”€ src/
β”‚ └── pages/
β”‚ └── index.astro
└── package.json
```
- [Features](#features)
- [Table of Contents](#table-of-contents)
- [πŸ‘€ Want to learn more?](#-want-to-learn-more)
- [Licence](#licence)

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.

<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/profile/dividers.png">

## 🧞 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 |

<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/profile/dividers.png">
<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/assets/dividers.png" alt="divider">

## πŸ‘€ Want to learn more?

Feel free to check [our documentation](https://docs.teaclient.net)

<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/profile/dividers.png">
<img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/assets/dividers.png" alt="divider">

# Licence

Expand Down

0 comments on commit 6e5fc55

Please sign in to comment.