Skip to content

Commit da87705

Browse files
authored
Update README.md
1 parent e5f465b commit da87705

1 file changed

Lines changed: 10 additions & 20 deletions

File tree

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# NovusNet
22

3-
NovusNet is a lightweight networking library designed to simplify client server communication. It enables developers to establish secure connections and exchange data in just a few lines of code without the complexity of large frameworks such as Boost.Asio.
3+
NovusNet is a lightweight networking library designed to simplify client server communication. It allows developers to make secure connections and exchange data in just a few lines of code without the complexity of larger libraries such as Boost.Asio or others.
44

5-
Built with indie developers and beginners in mind, NovusNet abstracts away low-level socket handling and encryption, allowing you to focus on building your application instead of managing networking boilerplate.
5+
NovusNet abstracts away low-level socket handling and encryption, allowing you to focus on building your application instead of managing networking boilerplate.
66

77
# Key Features
8-
- Minimal Setup: Get a client and server communicating in under 10 lines of code
9-
- Secure Communication: Built-in encryption for all data transmission
8+
- Get a client and server communicating in under 10 lines of code!
9+
- Native encryption for all data transmission
1010
- NFTP (Novus File Transfer Protocol): Send and receive files of any size with a single function call
11-
- Lightweight Design: No unnecessary overhead or complexity
12-
- Beginner-Friendly: Designed for ease of use and rapid integration
11+
- No unnecessary overhead or complexity
12+
- Designed for ease of use and rapid integration
1313
Project Status
1414

1515
# Early Development
@@ -37,7 +37,7 @@ NovusNet was created to eliminate that friction by providing a simple, reusable
3737
- [droidcom](https://github.com/droidcom) (Writer)
3838
# Usage Overview
3939

40-
Refer to Documentation.md for a full API reference. Below is a simplified example:
40+
Refer to documentation.md for a full API reference. Below is a simplified example:
4141

4242
# Server Example:
4343
```cpp
@@ -80,9 +80,7 @@ int main() {
8080
```
8181
# Example Projects
8282

83-
- NovusSync: File synchronization example (primarily for testing and demonstration)
84-
85-
Note: NovusSync is not production-ready and may require modification to function on your system.
83+
- NovusSync: File sync example (primarily for testing and demonstration)
8684

8785
# Installation
8886

@@ -101,7 +99,7 @@ git clone <repository-url>
10199
## 4. If using CMake:
102100
```bash
103101
add_executable(PROJECTNAME
104-
src/main.cpp
102+
src/yourfile.cpp
105103
src/nn.cpp
106104
)
107105

@@ -117,15 +115,7 @@ chmod +x gen.sh
117115
```
118116
# Notes:
119117
- Ensure key.pem and cert.pem are present in your build directory when running the server
120-
- Some IDEs may incorrectly highlight #include "nn.hpp" as an error—verify before troubleshooting
121-
122-
# Contributing:
123-
124-
Contributions are highly encouraged! If you're interested in improving NovusNet:
125-
126-
- Submit pull requests
127-
- Report bugs
128-
- Open discussions for new ideas
118+
- Some IDEs may incorrectly highlight #include "nn.hpp" as an error so dont mind it.
129119

130120
# Note
131121
If anyone can help me maintain this, please do. It's very hard maintaining it fully on my own although nobody uses it. Pull requests or discussions in issues are heavily appreciated!!

0 commit comments

Comments
 (0)