From 767f26f3c9e559154a51191799b144efb8ba946f Mon Sep 17 00:00:00 2001 From: NanamiAdmin Date: Wed, 13 May 2026 14:45:42 +0800 Subject: [PATCH] refactor(README): update configuration instructions and remove outdated features section --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3971293..e192aba 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,12 @@ A backend application for managing local frpc instances, allowing users to easily start, stop, restart, and perform daily maintenance operations on frpc instances. It also provides automated error handling, such as automatic restart when an instance crashes. -## Features - -- User authentication with token-based login -- Create, delete, and modify frpc instances -- Automatic startup configuration (systemd/init.d) -- User permission management (superuser/admin/visitor) -- SQLite database for data persistence - ## Supported Platforms - `GNU/Linux` - `Windows` -## Configuration +## Basic Configuration Create a `config.json` file in the project root: @@ -52,7 +44,7 @@ GOOS=linux GOARCH=amd64 go build -o super-frpc ## Run ```bash -./super-frpc -config ./config.json -db ./database.db +./super-frpc ``` ## API Documentation @@ -75,6 +67,9 @@ For detailed API documentation, please see [docs/api.md](docs/api.md) - [ ] Develop an agent software to handle windows service management - [ ] Refactor all log output level to be more clear - [x] Add frpc instance watchdog +- [ ] Add per-proxy status display +- [ ] Add proxy edit submit action +- [ ] Add per-proxy status control ## License