Skip to content

Commit 86ac4ae

Browse files
Update Readme
1 parent 9f41e82 commit 86ac4ae

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1+
# Teensy-Only Wiznet Ethernet Library
2+
3+
This copy of Ethernet for Wiznet chips is intended only for Teensy boards.
4+
For using with any non-Teensy board, please use Arduino's Ethernet:
5+
6+
https://github.com/arduino-libraries/Ethernet
7+
8+
Or use the copy of Ethernet from your board's vendor, if they publish a
9+
modified copy of Ethernet specifically for their boards.
10+
11+
### A bit of history
12+
13+
Back in 2018, I worked on unifying support for all 3 Wiznet chips
14+
(available at that time) with many performance improvements I had
15+
developed for Teensy's copy of Ethernet. I tested on many
16+
boards and it was released as Arduino Ethernet version 2.0.0.
17+
18+
https://www.pjrc.com/arduino-ethernet-library-2-0-0/
19+
20+
For a brief time, I was officially the maintainer for Arduino's
21+
Ethernet library. However, months later Arduino changed their
22+
repository access requirements, which I could not meet. I also
23+
became very busy with developing Teensy 4.0, leaving little time
24+
for testing Ethernet on other hardware.
25+
26+
In 2020, we released Teensy 4.1 with native ethernet, which offers
27+
vastly better performance than using a Wiznet chip. I do not
28+
anticipate spending much development time on Wiznet support in the
29+
foreseeable future. If you use Ethernet with Teensy, please consider
30+
Teensy 4.1 for future projects. The performance is so much better.
31+
32+
If you use a non-Teensy board, this is not the Ethernet library for you.
33+
Please do not report issue or ask for technical support for non-Teensy
34+
boards on this Teensy-specific repository.
35+
36+
137
# Improved Performance Ethernet Library
238

339
Wiznet chips W5100, W5200 and W5500 are automatically detected.

0 commit comments

Comments
 (0)