RageStudio/linebridge
1
0
Fork 0
mirror of https://github.com/ragestudio/linebridge.git synced 2025-06-09 10:34:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
SrGooglo 2024-09-25 21:08:43 +00:00
parent 0693272c39
commit f868164a4d
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -10,23 +10,24 @@ Currently used on RageStudio's services backends, like [Comty](https://github.co
## Suported Engines ## Suported Engines
- [hyper-express](https://github.com/kartikk221/hyper-express) (default) | High Performance Node.js Webserver. - [hyper-express](https://github.com/kartikk221/hyper-express) (default) | High Performance Node.js Webserver.
- worker | IPC Worker for sharding. - worker | IPC Worker for sharding and efficient multi-threading.
## Features ## Features
- Multiproposal - Multiproposal architecture | Designed to adapt to different project needs.
- Modular and extensible - Modular and Extensible | Easily add or replace components as needed.
- 🚀 Fast and scalable - 🚀 Fast & Scalable | Optimized for performance under high traffic.
- 🔐 Secure by default - 🔐 Secure by Default | Security-focused setup right out of the box.
- Supports WebSockets - 📡 Supports WebSockets | Real-time communication ready.
- 📦 Supports multiple protocols - 📦 Multi-Protocol Support | Communicate over multiple protocols effortlessly.
- Transcompiler included on bootloader - 🔧 Built-in Transcompiler | Automatically transcompiles code on boot for smoother deployment.
## Getting Started ## Getting Started
### Installation ### Installation
```bash ```bash
npm install linebridge npm install linebridge
``` ```
> Note: Use of Yarn can cause some issues to install the package. > [!WARNING]
> If you're using Yarn, you might encounter installation issues. We recommend using npm.
### Example ### Example
Create a http server Create a http server
@ -134,5 +135,5 @@ linebridge-boot index.js
``` ```
## Documentation ## Documentation
> On the way > The official documentation is on its way. Stay tuned for detailed guides and API references to help you unlock the full potential of Linebridge.
<!-- For more information, please visit the [documentation](https://docs.linebridge.com). --> <!-- For more information, please visit the [documentation](https://docs.linebridge.com). -->