Tiny grammar fixes
This commit is contained in:
parent
8e05734ee6
commit
f0dd3c9e46
1 changed files with 6 additions and 5 deletions
11
README.md
11
README.md
|
|
@ -1,13 +1,14 @@
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
|
||||||
<img src="https://github.com/titaniumnetwork-dev/Alu/assets/99224452/d740378b-3fba-4470-8f06-3eefdae8a313" alt="AluLogo" width="250"/>
|
<img src="https://github.com/titaniumnetwork-dev/Alu/assets/99224452/d740378b-3fba-4470-8f06-3eefdae8a313" alt="AluLogo" width="250"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# Alu
|
# 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.
|
||||||
|
|
||||||
<img src="https://shields.io/github/languages/code-size/titaniumnetwork-dev/Alu?style=flat-square&logo=github"/> <img src="https://shields.io/github/stars/titaniumnetwork-dev/Alu?style=flat-square&logo=github"/> <img src="https://img.shields.io/badge/made%20with-coffee-452515?style=flat-square&logo=coffeescript"/>
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
|
||||||
|
|
@ -28,14 +29,14 @@ Deploying Alu is about as simple as it gets.
|
||||||
|
|
||||||
2. Install pnpm with `npm i -g pnpm`.
|
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.
|
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! 🎉
|
Congrats! You should now be running your very own instance of Alu! 🎉
|
||||||
|
|
||||||
> [!WARNING]
|
> [!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?
|
## What about Docker?
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue