docs: add a simple usage doc

This commit is contained in:
kunish 2023-08-27 16:13:44 +08:00
parent 943d50bb8d
commit 6a04840cba
No known key found for this signature in database
GPG Key ID: 647A12B4F782C430
3 changed files with 19 additions and 29 deletions

View File

@ -1,34 +1,25 @@
# metacubexd
Clash-Meta Dashboard
![Alt text](docs/image.png)
## Usage
Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.
Install npm dependencies
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
```bash
$ npm install # or pnpm install or yarn install
```shell
pnpm install
```
### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
Build artifacts
## Available Scripts
```shell
pnpm build
```
In the project directory, you can run:
Serve static files
### `npm run dev` or `npm start`
Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.<br>
### `npm run build`
Builds the app for production to the `dist` folder.<br>
It correctly bundles Solid in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
## Deployment
You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)
```shell
pnpm preview
```

BIN
docs/image.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

View File

@ -1,14 +1,13 @@
{
"name": "metacubexd",
"version": "0.0.0",
"description": "clash-meta dashboard with daemon built in",
"description": "Clash-Meta Dashboard",
"license": "MIT",
"type": "module",
"scripts": {
"build": "vite build",
"dev": "vite",
"serve": "vite preview",
"start": "vite"
"serve": "vite preview"
},
"dependencies": {
"@felte/solid": "^1.2.10",