From 610e03a974c1b5d26f2278b711d912ed0de020d3 Mon Sep 17 00:00:00 2001 From: rift <117926989+Riftriot@users.noreply.github.com> Date: Wed, 27 Dec 2023 19:06:22 -0600 Subject: [PATCH] Update README.md --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 65 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4886cec..1d82d3c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,67 @@ -# Nebula rewrite +# Nebula -`npm i -g pnpm tsx` -`git clone https://github.com/NebulaServices/Nebula.git` -`git switch rewrite` -`pnpm i` +NebulaWeb is an official flagship of Nebula Services and Nebula Developer Labs. NebulaWeb is a stunning, sleek, and functional web-proxy with support for thousands of popular sites. With NebulaWeb, the sky is the limit. -readme meant for devs, will be changed before being merged into main + + +![license](https://img.shields.io/badge/License-GNU%20AGPL%20v3-blue) + + +## Features +- Stunning and highly functional UI +- 3 different backend proxies +- Hides your IP from sites +- [List of officially supported sites](https://github.com/NebulaServices/Nebula/blob/dev/docs/officially-supported-sites.md) +- Full mobile support +- `about:blank` cloaking) + +# Deployment + +Table of contents +- Deployment + + +--- +## Deployment +Run these commands on your server: +`git clone https://https://github.com/NebulaServices/Nebula.git` +`pnpm i` +`npm run bstart` + +You may also need to run `npm i -g pnpm tsx` +Thanks for using Nebula! + + +## Tech Stack + +- TypeScript, Tailwind +- Fastify +- TSX +- Framer motion +- react-i18next +- Ultraviolet (proxy) +- Dynamic (proxy) +- Rammerhead (proxy) +- TompHTTP Bare Server Node + +## Support + +For support, join our discord: discord.gg/unblocker + +## Demo + +[Click here to see a demo of Nebula](https://nebulaproxy.io/) + +## Acknowledgements + +- [UV (one of the proxies use)](https://github.com/titaniumnetwork-dev/Ultraviolet) +- [Dynamic (one of the proxies we use)](https://github.com/NebulaServices/Dynamic) +- [Rammerhead (one of the proxies we use)](https://github.com/binary-person/rammerhead) +- [Bare Server Node](https://github.com/tomphttp/bare-server-node) + +## License + +(Nebula's license is now GNU AGPL V3 as of v7.10) +Copyright Nebula Services 2021 - Present +
+This project uses the AGLP GNU V3 license.