diff --git a/README.md b/README.md index 6a17645..9a8ed74 100644 --- a/README.md +++ b/README.md @@ -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.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.
- -### `npm run build` - -Builds the app for production to the `dist` folder.
-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.
-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 +``` diff --git a/docs/image.png b/docs/image.png new file mode 100644 index 0000000..dee4f51 Binary files /dev/null and b/docs/image.png differ diff --git a/package.json b/package.json index 207b7fc..d30e97e 100644 --- a/package.json +++ b/package.json @@ -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",