You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-20Lines changed: 10 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
# NovusNet
2
2
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.
4
4
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.
6
6
7
7
# 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
10
10
- 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
13
13
Project Status
14
14
15
15
# Early Development
@@ -37,7 +37,7 @@ NovusNet was created to eliminate that friction by providing a simple, reusable
37
37
-[droidcom](https://github.com/droidcom) (Writer)
38
38
# Usage Overview
39
39
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:
41
41
42
42
# Server Example:
43
43
```cpp
@@ -80,9 +80,7 @@ int main() {
80
80
```
81
81
# Example Projects
82
82
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)
86
84
87
85
# Installation
88
86
@@ -101,7 +99,7 @@ git clone <repository-url>
101
99
## 4. If using CMake:
102
100
```bash
103
101
add_executable(PROJECTNAME
104
-
src/main.cpp
102
+
src/yourfile.cpp
105
103
src/nn.cpp
106
104
)
107
105
@@ -117,15 +115,7 @@ chmod +x gen.sh
117
115
```
118
116
# Notes:
119
117
- 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.
129
119
130
120
# Note
131
121
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