Skip to content

Commit

Permalink
📝 Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SebaOfficial committed Jan 9, 2024
1 parent fdb1883 commit 874a2d3
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 217 deletions.
140 changes: 0 additions & 140 deletions README-zh.md

This file was deleted.

118 changes: 41 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,66 @@
<p align="right"><strong>English</strong> | <a href="https://github.com/kwchang0831/svelte-QWER/blob/main/README-zh.md">中文</a></p>

<p align="center">
<a href="https://svelte-qwer.vercel.app/"><img src=https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/avatar.png width=96 hieght=96 style="border-radius: 9999px; object-fit: cover;" /></a>
<a href="https://qwer.racca.me/"><img src=https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/avatar.png width=96 hieght=96 style="border-radius: 9999px; object-fit: cover;" /></a>
</p>

<h1 align="center">QWER</h1>

<p align="center">
Simply Awesome <b>Blog Starter</b> built with <b>SvelteKit</b> and <b>❤</b>
Simply Awesome <b>Blog Starter</b> built in <b>SvelteKit</b>
</p>

<p align="center"><img src="https://img.shields.io/github/languages/top/kwchang0831/svelte-QWER?color=%23ff3e00&logo=Svelte" alt="Language" />
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/kwchang0831/svelte-QWER" alt="License"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/CHANGELOG-svelte--QWER-lightgreen?logo=Keep a Changelog" alt="svelte-QWER"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/QWER/CHANGELOG.md"><img src="https://img.shields.io/badge/CHANGELOG-QWER-lightgreen?logo=Keep a Changelog" alt="QWER"></a></p>

<p align="center">
<a href="https://svelte-qwer.vercel.app/"><img src="https://img.shields.io/badge/🚀 DEMO-Vercel-informational?style=for-the-badge" alt="QWER Vercel DEMO">
</a><a href="https://svelte-qwer.netlify.app/"><img src="https://img.shields.io/badge/🚀 DEMO-Netlify-informational?style=for-the-badge" alt="QWER Netlify DEMO"></a>
<img src="https://img.shields.io/github/languages/top/SebaOfficial/QWER?color=%23ff3e00&logo=Svelte" alt="Svelte Percentage" />
<a href="https://github.com/SebaOfficial/QWER/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/SebaOfficial/QWER" alt="QWER License">
</a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/CHANGELOG.md">
<img src="https://img.shields.io/badge/CHANGELOG-QWER-lightgreen?logo=Keep a Changelog" alt="QWER Changelog">
</a>
</p>

<p align="center">
<a href="https://github.com/kwchang0831/svelte-QWER/discussions/categories/q-a"><img src="https://img.shields.io/badge/💬 Discussion-Q&A-informational?style=for-the-badge" alt="QWER Q&A"></a>
<a href="https://docs-svelte-qwer.vercel.app/"><img src="https://img.shields.io/badge/📝 Documentation-DOCS-informational?style=for-the-badge" alt="QWER DOCS"></a>
<a href="https://qwer.racca.me/">
<img src="https://img.shields.io/badge/🚀 DEMO-Github%20Pages-informational?style=for-the-badge" alt="Github Pages Demo">
</a>
</p>

<p align="center"><a href="https://pagespeed.web.dev/report?url=https%3A%2F%2Fsvelte-qwer.vercel.app%2F&form_factor=desktop"><img style="float:middle" width="auto" alt="PAGESPEED" src="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"></a></p>

## 🎉 Try [QWER](https://github.com/kwchang0831/svelte-QWER/) out
<p align="center">
<a href="https://qwer.racca.me/docs">
<img src="https://img.shields.io/badge/📝 Documentation-DOCS-informational?style=for-the-badge" alt="Documentation">
</a>
<a href="https://pagespeed.web.dev/report?url=https%3A%2F%2Fqwer.racca.me%2F&form_factor=desktop">
<img src="https://img.shields.io/badge/🚀 Page%20Speed-INSIGHTS-informational?style=for-the-badge" alt="QSpeed Insights">
</a>
</p>

# 🛠 Installation
You can install QWER with `npx`:
```bash
npx degit kwchang0831/svelte-QWER my-blog
npx degit sebaofficial/QWER my-blog
```

<p align="center"><a href="https://svelte-qwer.vercel.app"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></a></p>
<br/>
<p align="center"><a href="https://svelte-qwer.vercel.app"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></a></p>

## ⚡️ Usage

1. Get [npm v18.x](https://nodejs.org/en/blog/release/v18.17.0)

1. Get [pnpm](https://github.com/pnpm/pnpm).

# ❔ Usage
1. Get [npm](https://nodejs.org/en/blog/release/) *v18 or higher*;
2. Get [npm](https://github.com/pnpm/pnpm):
```bash
npm i -g pnpm
```

1. Install all the dependencies.

3. Install the dependencies:
```bash
pnpm i
```

1. Run local dev server.

4. Run local dev server:
```bash
pnpm dev
```

1. Create an article folder (For Windows users, make sure to use a terminal that supports Bash scripts, such as Git Bash).

5. Create a post:
```bash
pnpm run createblog YOURDIRNAME
pnpm run create-post my-post
```

## ✨ Features
> Full documentation can be found [here](https://qwer.racca.me/docs).

# ✨ Features

- ⚡ Super fast site performance. Near **Perfect** [PageSpeed](https://pagespeed.web.dev/) score.

Expand Down Expand Up @@ -97,45 +92,14 @@ npx degit kwchang0831/svelte-QWER my-blog

- 🌐 i18n via [typesafe-i18n](https://github.com/ivanhofer/typesafe-i18n).

- 🚀 Deploy the blog **Free** on [Vercel](https://vercel.com/), [Netlify](https://Netlify.com/), or [Cloudflare Pages](https://pages.cloudflare.com/).

## 📚 Learn More

Please read our [Documentation](https://docs-svelte-qwer.vercel.app/).

## 👷 Current State

[QWER](https://github.com/kwchang0831/svelte-QWER) is at its' very early stage. Kindly expect frequent breaking changes.
Just copy and paste your `user` folder to the latest release.
Watch out for the CHANGELOG to see if yor are required to migrate `user/config` or other places.
## ❓ Issues / Problems / Questions
Please take advantage of our [Github's Q&A Discussion board](https://github.com/kwchang0831/svelte-QWER/discussions/categories/q-a).

## 😊 Are you using QWER?
- 🚀 Deploy the blog **Free** on [Vercel](https://vercel.com/), [Netlify](https://Netlify.com/), [Cloudflare Pages](https://pages.cloudflare.com/) or [GitHub Pages](https://pages.github.com).

# 😊 Are you using QWER?
Please consider adding `svelte-qwer` topic to your repository.
To see who else is using QWER, please check [Github-Topics: svelte-qwer](https://github.com/topics/svelte-qwer).

To see who else are using QWER, please check [Github-Topics: svelte-qwer](https://github.com/topics/svelte-qwer).

## 🎉 Support

<div class="flex" style="display:inline-block; font-size: 24px; --un-bg-opacity: 1; background-color: rgba(255, 221, 0); border-radius: 0.5rem; padding: 12px 18px; border: 2px solid;">
<a class="flex" href="https://www.buymeacoffee.com/kwchang0831" style="color: black;" >
<span>🥓</span>
<span>Buy me a Bacon</span>
</a>
</div>

## 📝 License

[MIT](https://github.com/kwchang0831/svelte-QWER/blob/main/LICENSE)

## 🙏 Credits

- Cover Photo by <a href="https://unsplash.com/@jessbaileydesigns?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Jess Bailey</a> on <a href="https://unsplash.com/s/photos/note?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Unsplash</a>
# 🙏 Credits
- This is a fork of [kwchang0831/svelte-QWER](https://github.com/kwchang0831/svelte-QWER) with some improvements, if you're using this repository consider giving a start to [kwchang0831/svelte-QWER](https://github.com/kwchang0831/svelte-QWER).
- Avatar Illustration by <a href="https://icons8.com/illustrations/author/GrbQqWBEhaDS">Liam Moore</a> from <a href="https://icons8.com/illustrations">Ouch!</a>
# ⚖️ License
This project is under the [MIT License](https://github.com/SebaOfficial/QWER/blob/main/LICENSE).

0 comments on commit 874a2d3

Please sign in to comment.