From f2fcf293174a536641bded53f24363aae6c69c29 Mon Sep 17 00:00:00 2001 From: wearr <99224452+wearrrrr@users.noreply.github.com> Date: Mon, 29 Jul 2024 20:22:17 -0500 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 856bf3d..2b6c241 100644 --- a/README.md +++ b/README.md @@ -12,28 +12,30 @@ Alu is a beautiful, functional, and sleek web proxy, which focuses on customizat # Features - 🌐 UV and Rammerhead support -- 🎨 Themes +- 🎨 Multiple Themes to choose from +- 🏬 Marketplace for Themes and Extensions - 🕶 Multiple site cloaking options - 🎮 50+ Games to choose from -- 🌎 English and Japanese support +- 🌎 Support for **6** Languages - 🚀 High performance - 🔍 Multiple Search Engines to pick from # Deploying Alu -Deploying Alu is about as simple as it gets, from your terminal, type +Deploying Alu is about as simple as it gets. -`git clone https://github.com/titaniumnetwork-dev/Alu --recurse-submodules` +1. Open your terminal and type `git clone https://github.com/titaniumnetwork-dev/Alu --recurse-submodules` -This command should clone Alu's frontend, as well as [alu-games](https://github.com/wearrrrr/alu-games). If you wish to skip cloning games, then leave out the last flag. +2. Install pnpm with `npm i -g pnpm`. -Install pnpm with `npm i -g pnpm`. +3. Then simply run `pnpm i` to install all node_modules, and then build the frontend with `pnpm run build`, this shouldn't take more than a couple seconds. -Then simply run `pnpm i` to install all node_modules, and then build the frontend with `pnpm run build`, this shouldn't take more than a couple seconds. +4. Finally, run `pnpm start` to actually serve Alu! It defaults to port 3000 for everything, but this can be specified in an env file. -Finally, run `pnpm start` to actually serve Alu! It defaults to port 3000 for everything, but this can be specified in an env file. +Congrats! You should now be running your very own instance of Alu! 🎉 -Congrats, you've now deployed your very own web proxy! +> [!WARNING] +> Recursing all submodules will install [alu-games](https://github.com/wearrrrr/alu-games) as well. This repo contains *all* games for Alu, and is quite large! If you wish to skip it, simply remove `--recurse-submodules` from your clone command. ## What about Docker?