Skip to content

Commit a3f24e4

Browse files
authored
chore: update readme
1 parent 766e7c2 commit a3f24e4

File tree

1 file changed

+5
-55
lines changed

1 file changed

+5
-55
lines changed

README.md

+5-55
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,7 @@
1-
# Docus Starter
1+
<p align="center">
2+
<img src="https://i.imgur.com/GTPBh5x.png" />
3+
</p>
24

3-
Starter template for [Docus](https://docus.dev).
5+
# Automata | Documentation
46

5-
## Clone
6-
7-
Clone the repository (using `nuxi`):
8-
9-
```bash
10-
npx nuxi init -t themes/docus
11-
```
12-
13-
## Setup
14-
15-
Install dependencies:
16-
17-
```bash
18-
yarn install
19-
```
20-
21-
## Development
22-
23-
```bash
24-
yarn dev
25-
```
26-
27-
## Edge Side Rendering
28-
29-
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
30-
31-
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
32-
33-
```bash
34-
yarn build
35-
```
36-
37-
## Static Generation
38-
39-
Use the `generate` command to build your application.
40-
41-
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
42-
43-
```bash
44-
yarn generate
45-
```
46-
47-
## Preview build
48-
49-
You might want to preview the result of your build locally, to do so, run the following command:
50-
51-
```bash
52-
yarn preview
53-
```
54-
55-
---
56-
57-
For a detailed explanation of how things work, check out [Docus](https://docus.dev).
7+
This repository contains the documentation for the [Automata](https://github.com/shadowrunners/Automata) lavalink wrapper built with Nuxt, Docus and Markdown.

0 commit comments

Comments
 (0)