From a0e09a4d0492db7fc6ff5998ebf6970553c5abe0 Mon Sep 17 00:00:00 2001 From: SpikeHD Date: Tue, 19 Apr 2022 16:19:27 -0700 Subject: [PATCH] readme base --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 4f33211..35c0bf6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # GrassClipper Grasscutter launcher for easily switching between Official and Private servers + +[Download Here!](https://github.com/Grasscutters/GrassClipper/releases/) + +# Setup + +0. Clone the repository +1. Ensure you have [NodeJS](https://nodejs.org/en/download/) installed. +2. Install the `neu` CLI tool: `npm install -g @neutralinojs/neu` +3. Install the dependancies: `npm install` +4. Compile and run: + * For testing: `npm run dev` + * For production: `npm run build` + +# TODO + +* Interface + * UI + * Official and Private options + * Server IP input + * Fun fancy CSS styling n stuff (CoD: MW 2019-style vertical menu for choosing between official and private servers? [See this](https://charlieintel.com/wp-content/uploads/2020/11/MW-new-menu.png)) +* Proxy service + * Local proxy server + * Intercept and modify GI requests like with Fiddler, allow anything else to pass through \ No newline at end of file