Skip to content

Commit c5387db

Browse files
committed
docs: 📝 Refactor README to improve appearance
1 parent 70c83da commit c5387db

File tree

3 files changed

+55
-26
lines changed

3 files changed

+55
-26
lines changed

README.md

+55-26
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,42 @@
1-
<p align="center">
2-
<a href="https://versia.pub"><img src="https://cdn.versia.pub/branding/logo-dark.svg" alt="Versia Logo" height="110"></a>
3-
</p>
4-
5-
<center><h1><code>versia-fe</code></h1></center>
6-
7-
**Versia-FE** is a beautiful, fast and responsive front-end for the Versia Server project.
8-
9-
## Features
1+
<center>
2+
<a href="https://versia.pub">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://cdn.versia.pub/branding/logo-dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="https://cdn.versia.pub/branding/logo-light.svg">
6+
<img src="https://cdn.versia.pub/branding/logo-dark.svg" alt="Versia Logo" height="110" />
7+
</picture>
8+
</a>
9+
</center>
10+
11+
12+
<h2 align="center">
13+
<strong><code>Versia Frontend</code></strong>
14+
</h2>
15+
16+
<div align="center">
17+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/typescript/typescript-original.svg" height="42" width="52" alt="TypeScript logo">
18+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/vuejs/vuejs-original.svg" height="42" width="52" alt="Vue logo">
19+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/nuxtjs/nuxtjs-original.svg" height="42" width="52" alt="Nuxt logo">
20+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/docker/docker-original.svg" height="42" width="52" alt="Docker logo">
21+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/bun/bun-original.svg" height="42" width="52" alt="Bun logo">
22+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/css3/css3-original.svg" height="42" width="52" alt="CSS3 logo">
23+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/html5/html5-original.svg" height="42" width="52" alt="HTML5 logo">
24+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/linux/linux-original.svg" height="42" width="52" alt="Linux logo">
25+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/tailwindcss/tailwindcss-original.svg" height="42" width="52" alt="TailwindCSS logo">
26+
</div>
27+
28+
29+
<br/>
30+
31+
<center>
32+
<picture>
33+
<source media="(prefers-color-scheme: dark)" srcset="assets/ipad-dark.webp">
34+
<source media="(prefers-color-scheme: light)" srcset="assets/ipad-light.webp">
35+
<img alt="Versia-FE screenshot on an iPad Pro" src="assets/ipad-dark.webp" height="400" />
36+
</picture>
37+
</center>
38+
39+
# Features
1040

1141
- [x] Timelines: public, home, local
1242
- [x] Login
@@ -22,12 +52,11 @@
2252
- [x] Note editing
2353
- [x] Alt text support everywhere
2454
- [x] Media uploads
25-
- [x] WCAG 2.2 AAA compliance
26-
- Testing is automated and will not catch all issues, please report any accessibility issues you find.
55+
- [x] WCAG 2.2 AAA testing
2756
- [x] Settings
2857
- [x] Profile editing
2958

30-
### Browser Support
59+
## Browser Support
3160

3261
The following browsers are **supported** (issues will be prioritized):
3362
- **Chromium**: `110+`
@@ -43,27 +72,27 @@ The following browsers will very likely work, but are not officially supported:
4372

4473
Other browsers may work, but are not guaranteed to.
4574

46-
## Performance
75+
# Performance
4776

48-
### JavaScript
77+
## JavaScript
4978

5079
The **total** JavaScript bundle size is less than `1000 kB`, but this is made even smaller by the fact that the bundle is split into multiple files, and only the necessary files are loaded on each page.
5180

52-
### Benchmarks
81+
## Benchmarks
5382

5483
Soon™.
5584

56-
## Installation
85+
# Installation
5786

5887
Versia-FE is included in the provided `docker-compose` file during [Versia Server installation](https://github.com/versia-pub/server/blob/main/docs/installation.md).
5988

6089
To have Versia-FE and Versia Server running on the same domain, edit the Versia Server configuration to point to the Versia-FE container's address (`frontend` category inside config).
6190

62-
### Manual Installation
91+
## Manual Installation
6392

6493
Here are the steps to install Versia-FE manually:
6594

66-
#### Docker/Podman
95+
### Docker/Podman
6796

6897
```yaml
6998
services:
@@ -83,7 +112,7 @@ Then, the frontend will be available at `http://localhost:3000` inside the conta
83112
>
84113
> You can set the `NUXT_PUBLIC_API_HOST` environment variable to point to a different Versia Server instance.
85114

86-
#### Manual
115+
### Manual
87116

88117
1. Clone the repository.
89118
```bash
@@ -99,26 +128,26 @@ bun run build
99128
```
100129
4. Serve the static files in the `.output/public` directory.
101130
> [!WARNING]
102-
>
131+
>
103132
> `.output/public/200.html` should be configured as a fallback for all 404 errors.
104133

105-
## Development
134+
# Development
106135

107136
Run `bun run emojis:generate` to generate the emoji list before building or running the project.
108137

109-
## License
138+
# License
110139

111140
This project is licensed under the AGPL 3.0 - see the [LICENSE](LICENSE) file for details.
112141

113142
All Versia assets (icon, logo, banners, etc) are licensed under [CC-BY-NC-SA-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0).
114143

115-
## Acknowledgments
144+
# Acknowledgments
116145

117-
### Projects
146+
## Projects
118147

119148
- [**Bun**](https://bun.sh): Thanks to the Bun team for creating an amazing JavaScript runtime.
120149
- [**Nuxt**](https://nuxt.com): Thanks to the Nuxt team for creating an amazing Vue framework.
121150

122-
### People
151+
## People
123152

124-
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.
153+
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.

assets/ipad-dark.webp

63.1 KB
Binary file not shown.

assets/ipad-light.webp

64.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)