Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sayad-Uddin-Tahsin authored Aug 24, 2023
1 parent 34c7361 commit 857ef87
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# IPCom
IPCom is an offline messaging application that allows users to send messages without an internet connection. It uses the same Wi-Fi connection to send messages between devices. This makes it ideal for situations where there is no internet connection available but you still need to communicate with others. There matter is to have on same Wi-Fi/Hotspot!
IPCom is an offline messaging application that allows users to send messages without an internet connection. It uses IP to send messages between devices. This makes it ideal for situations where there is no internet connection available but you still need to communicate with others. The matter is to have on same Network!

## How it works?
It needs a server to work. When the server is online anyone with the same wi-fi will able to connect with the server and send message with others connected with the same server. Say `You` and 3 of your friends are connected on a server, the communication is done as this diagram shows:
It needs a server to work. When the server is online anyone with the same network will able to connect with the server and send message with others connected with the same server. Say `You` and 3 of your friends are connected on a server, the communication is done as this diagram shows:

```mermaid
graph TD;
Expand All @@ -19,21 +19,13 @@ graph TD;
```

## Installation
Currently, no executable release is available. However, you can download the source code and run the application manually. Please note that Python needs to be installed on your system.
Download the Latest IPCom Installer from [Releases](https://github.com/Sayad-Uddin-Tahsin/IPCom/releases).

To run the application:

1. Clone or download this repository to your local machine.
2. Open a terminal or command prompt and navigate to the project directory.
3. Run the IPCom Server using the following command:
```bash
python server.py
```
4. Run the IPCom application also to join yourself using the following command:
```bash
python ipcom.py
```
Make sure you have Python installed on your system.
### Installer Contains
- IPCom
- Let you connect to a server and chat
- IPCom Server
- Let you create a new server

## License
This project is licensed under the [MIT License](./LICENSE).

0 comments on commit 857ef87

Please sign in to comment.