Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nouman0103 authored Apr 15, 2022
1 parent cf2f4f9 commit e9bd19f
Showing 1 changed file with 13 additions and 27 deletions.
40 changes: 13 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,35 @@
# winerp
An IPC based on Websockets. Fast, Stable, and Reliable, perfect for communication between your processes or discord.py bots.
An IPC based on Websockets. Fast, Stable, and easy-to-use, for inter-communication between your processes or discord.py bots.

### Key Features

- **Fast** with minimum recorded response time being `< 2ms`
- Lightweight, Stable and Easy to integrate.
- No limitation on number of connected clients.

## Installation
Stable:
```py
pip install winerp
pip install -U winerp
```
Main branch (can be unstable/buggy):
```py
pip install git+https://www.github.com/BlackThunder01001/winerp
```

## Working:
This library uses a central server for communication between multiple processes. You can connect a large number of clients for sharing data, and data can be shared between any connected client.
### Working:
This library uses a central server for communication between multiple clients. You can connect a large number of clients for sharing data, and data can be shared between any connected client.


## Example Usage:

### Server Side:
```py
import winerp

server = winerp.Server(port=8080)
server.start()
```
Start the server on terminal using `$ winerp --port 8080`. You can also start the server using `winerp.Server`

### Client 1 (`some-random-bot`):
```py

import winerp
import discord
from discord.ext.commands import Bot

import winerp

bot = Bot(command_prefix="!", intents=discord.Intents.all())

bot.ipc = winerp.Client(local_name = "some-random-bot", loop = bot.loop, port=8080)
Expand All @@ -59,11 +56,9 @@ bot.run("TOKEN")

### Client 2 (`another-bot`)
```py
import winerp
import discord
from discord.ext.commands import Bot

import winerp

bot = Bot(command_prefix="?", intents=discord.Intents.all())

bot.ipc = winerp.Client(local_name = "another-bot", loop = bot.loop, port=8080)
Expand All @@ -84,12 +79,3 @@ bot.loop.create_task(bot.ipc.start())
bot.run("TOKEN")
```

# Features

- Fast: Minimum Response Time Recorded: **< 2ms**.
- Reliable, Stable and Easy to integrate.
- A single hosted server can be used to serve all clients on the machine.
- No limitation on number of connected clients.
- Inter bot-communication possible.
- Inter server-communication possible.

0 comments on commit e9bd19f

Please sign in to comment.