Merge pull request #10 from hahunavth/hotfix/update-readme

Update README.md
hahunavth · Feb 19, 2023 · 4165110 · 4165110
2 parents bed5045 + f5d6b75
commit 4165110
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,16 @@
-# meshchat
-Chat application using TCP protocol. 
+# Meshchat
+Welcome to the meshchat repository! This repository contains the code for a secure chat application with TCP protocol.
 
-## Folder structure
-- client: application java client
-- server: application c server
-- client-lib: c library build for client
+## Structure
+The repository contains three main folders:
+
+- `client`: This folder contains the Java code for the client application.
+- `client-lib`: This folder contains C code for building a library that can be called from Java using jnr-ffi.
+- `server`: This folder contains the Java code for the server application.
+
+## Getting started
+To use the meshchat application, follow these steps:
 
-## Setup
 - Server: 
   ```shell
   cd ./server
@@ -22,3 +26,8 @@ Chat application using TCP protocol.
     ```
   - Run java client using intellji idea
 
+## Contributing
+We welcome contributions to the meshchat project! If you find a bug or have an idea for a new feature, please submit a pull request.
+
+## License
+The MeshChat Client code is licensed under the MIT license. See the [LICENSE](./LICENSE.md) file for more details.
diff --git a/client/README.md b/client/README.md
@@ -1,9 +1,13 @@
-# Client
+# MeshChat Client
+MeshChat Client is a messaging application that allows users to communicate with each other in a secure network. This repository contains the code for the client-side implementation of the application, written in Java.
 
-## Native library
-
-- libcli_service: TCP socket API library for client in `client/src/main/resources/libcli_service.so`
-  - How to build: [here](../client-lib/README.md)
+# Dependencies
+To build and run MeshChat Client, you will need:
+- Java Development Kit (JDK) 17 or later
+- JavaFX SDK 17 or later
+- Gradle build system
+The native library libcli_service.so is also included in the repository, which provides the TCP socket API for the client.
+- How to build: [here](../client-lib/README.md)
 
 ### Map type
 ```java
@@ -73,4 +77,4 @@
         │           └── client          # test file
         └── resources
             ├── com.meshchat.client           # test resource
-```
+```