Skip to content

Commit

Permalink
docs: Make README pretty
Browse files Browse the repository at this point in the history
  • Loading branch information
aklinker1 authored Sep 7, 2023
1 parent 5f15f9c commit b33b663
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,30 @@
<h1 align="center">WXT</h1>
<h1 align="center">
<img style="vertical-align:middle" width="44" src="./docs/public/hero-logo.svg" alt="WXT Logo">
<span>WXT</span>
</h1>

<p align="center"><img align="center" width="44" src="./docs/public/hero-logo.svg" alt="WXT Logo"></p>
<p class="float: left"></p>

<p align="center"><i>Next gen framework for developing web extensions.<br/>Powered by <a href="https://vitejs.dev/" target="_blank">Vite</a>. Inspired by <a href="https://nuxt.com/" target="_blank">Nuxt</a>.</i></p>
<p align="center">Next-gen framework for developing web extensions.<br/>◇<br/><q><i>It's like Nuxt, but for Chrome Extensions</i></q></p>

![Example CLI Output](./docs/assets/cli-output.png)

<p align="center">
<a href="https://github.com/wxt-dev/wxt/actions/workflows/validate.yml" target="blank"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/wxt-dev/wxt/validate.yml?label=Checks"></a>
<a href="https://wxt.dev" target="blank"><img alt="Documentation" src="https://img.shields.io/badge/Docs-wxt.dev-blue"></a>
<a href="https://github.com/wxt-dev/wxt-examples" target="blank"><img alt="Examples" src="https://img.shields.io/badge/Examples-GitHub-blue"></a>
</p>

## Quick Start

Bootstrap a new project:

```sh
pnpx wxt@latest init <project-name>
```

Or see the [installation guide](https://wxt.dev/get-started/installation.html) to get started with WXT.

## Features

- 🌐 Supports all browsers
Expand All @@ -23,10 +42,6 @@
- 📏 Bundle analysis
- 🤖 Automated publishing

## Get Started

Checkout the [installation guide](https://wxt.dev/get-started/installation.html) to get started with WXT.

## Contributors

<a href="https://github.com/wxt-dev/wxt/graphs/contributors">
Expand Down

0 comments on commit b33b663

Please sign in to comment.