diff --git a/README.md b/README.md index bc82bbd..b0da38e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@

- AluLogo

# Alu -Alu is a beautiful, functional, and sleek web proxy, which focuses on customization and ease of use. +Alu is a beautiful, functional, and sleek web proxy that prioritizes customization and ease of use. - +![Code size](https://shields.io/github/languages/code-size/titaniumnetwork-dev/Alu?style=flat-square&logo=github) +![Star count](https://shields.io/github/stars/titaniumnetwork-dev/Alu?style=flat-square&logo=github) +![Made with coffee](https://img.shields.io/badge/made%20with-coffee-452515?style=flat-square&logo=coffeescript) # Features @@ -28,14 +29,14 @@ Deploying Alu is about as simple as it gets. 2. 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. +3. Then simply run `pnpm i` to install all node_modules, and 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. Congrats! You should now be running your very own instance of Alu! 🎉 > [!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. +> 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?