Skip to content

Commit 424c001

Browse files
authored
Update README.md
removed escape characters from markdown that where not required
1 parent bd4e263 commit 424c001

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,37 +27,37 @@ It now features an event-driven design using callbacks, allowing your main sketc
2727

2828
The library is now event-driven. You can register callback functions in `setup()` that will automatically execute when the network status changes. The `netManager.loop()` function must still be called on every iteration of your sketch's main `loop()`.
2929
```c
30-
\#include \<SPI.h\>
31-
\#include \<Ethernet.h\>
32-
\#include "SimpleNetManager.h"
30+
#include <SPI.h>
31+
#include <Ethernet.h>
32+
#include "SimpleNetManager.h"
3333

3434
// The library is now in a namespace to prevent naming conflicts.
3535
using namespace SimpleNet;
3636

3737
// Define the MAC address for your Ethernet shield.
38-
byte mac\[\] \= { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
38+
byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
3939

4040
// Instantiate the network manager.
4141
// You can pass 'Serial' to the constructor to enable debug messages.
42-
SimpleNetManager netManager(mac, \&Serial);
42+
SimpleNetManager netManager(mac, &Serial);
4343

44-
// \--- Callback Functions \---
44+
// --- Callback Functions ---
4545
// This function will be called automatically when the network connects.
4646
void onNetworkConnect() {
47-
Serial.println("\\n--- Network Connected\! \---");
47+
Serial.println("\n--- Network Connected! ---");
4848
Serial.print("IP Address: ");
4949
Serial.println(Ethernet.localIP());
5050
}
5151

5252
// This function will be called automatically when the network disconnects.
5353
void onNetworkDisconnect() {
54-
Serial.println("\\n--- Network Disconnected\! \---");
54+
Serial.println("\n--- Network Disconnected! ---");
5555
Serial.println("Attempting to reconnect...");
5656
}
5757

5858
void setup() {
5959
Serial.begin(9600);
60-
while (\!Serial) { ; }
60+
while (!Serial) { ; }
6161

6262
// Register our callback functions
6363
netManager.onConnect(onNetworkConnect);
@@ -74,7 +74,7 @@ void loop() {
7474

7575
// Your main application logic can now run independently.
7676
if (netManager.isConnected()) {
77-
// \--- Your networking code goes here \---
77+
// --- Your networking code goes here ---
7878
// This part will only run when connected.
7979
}
8080
}
@@ -83,11 +83,11 @@ void loop() {
8383

8484
All components are within the `SimpleNet` namespace.
8585

86-
#### **SimpleNetManager(byte mac\[\], Stream\* debugStream \= nullptr)**
86+
#### **SimpleNetManager(byte mac[], Stream\* debugStream = nullptr)**
8787

8888
The constructor.
8989

90-
* **`mac\[\]`**: A 6-byte array for the MAC address.
90+
* **`mac[]`**: A 6-byte array for the MAC address.
9191
* **`debugStream`**: An optional pointer to a Stream object (like \&Serial) to print debug output.
9292

9393
#### **void begin() & void begin(...)**
@@ -130,4 +130,4 @@ This project was developed with the assistance of Google's Gemini.
130130

131131
## **License**
132132

133-
This project is licensed under the MIT License \- see the LICENSE file for details.
133+
This project is licensed under the MIT License \- see the LICENSE file for details.

0 commit comments

Comments
 (0)