README update

Author: JAndrassy

README.md

@@ -1,19 +1,29 @@
 
-An plugin-replacement of the stock Arduino Ethernet library for ENC28J60 shields and breakout boards. Full support for persistent (streaming) TCP-connections and UDP (Client and Server each), ARP, ICMP, DHCP and DNS. 
-Just include 'EthernetENC.h' instead of 'Ethernet.h' and use all your code written for the stock Arduino Ethernet lib!
+EthernetENC is the Ethernet library for ENC28J60. It is a modern version of the UIPEthernet library.
 
-UIPEthernet is written as a wrapper around the mature uIP Stack by Adam Dunkels, which provides the low-level implementation for all supported protocols. To overcome the memory-constrains (a 'regular' uIP-application does all processing in RAM) the ENC28J60 internal memory is used for all stream buffers (in and out). Only 400-600 Bytes of Arduinos RAM are used (depending on the number of concurrently open connections). As of Flash-memory a ATmega368-based Arduino is the minimum requirenment.
+The modernization includes:
+* Ethernet 2.0 library functions
+* support of many Arduino architectures by using the SPI library
+* SPI transactions to share the SPI bus with devices with different communication settings
+* heavy buffering of sent TCP data in ENC with flush() function to send the last buffer
+
+[The documentation of Arduino Ethernet library](https://www.arduino.cc/en/Reference/Ethernet) applies for class and functions descriptions.
+
+This library doesn't have examples, because examples of the Arduino Ethernet library apply. You can find them in the Arduino IDE Examples menu Ethernet section. Only change `#include <Ethernet.h>` to `#include <EthernetENC.h>`.  
+
+This library is based on the Norbert Truchsess's arduino-uip original source code repository and uses experience from the development of the multiarchitecture support by Cassy for UIPEthernet library which is published in Library Manager. Applicable fixes and enhancements from developed of EthernetENC were transfered to Cassy's UIPEthernet.
+
+You can find more information in project's [Wiki](https://github.com/jandrassy/EthernetENC/wiki).
+
+## Original notes by Norbert Truchsess
 
-This library is written by Norbert Truchsess <[email protected]>
+UIPEthernet is written as a wrapper around the mature uIP Stack by Adam Dunkels, which provides the low-level implementation for all supported protocols. To overcome the memory-constrains (a 'regular' uIP-application does all processing in RAM) the ENC28J60 internal memory is used for all stream buffers (in and out). Only 400-600 Bytes of Arduinos RAM are used (depending on the number of concurrently open connections). As of Flash-memory a ATmega368-based Arduino is the minimum requirenment.
 
 uIP was written by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
 
 This library was inspired by the SerialIP implementation by Adam Nielsen <[email protected]>, actually I took this code as a starting point, but in the latest versions there are very few lines left.
 
-## Documentation
-
-For more information visit Arduino Ethernet library description http://arduino.cc/en/Reference/Ethernet
-    
+ 
 ## Licenses
 ```
 UIPEthernet.h
@@ -112,43 +122,6 @@ SUCH DAMAGE.
 
 --------------
 
-uip-conf.h
-utility/uip-neighbor.h
-utility/uip-neighbor.c
-utility/uip_timer.h
-utility/uip_timer.c
-utility/uip_clock.h
-
-Author Adam Dunkels Adam Dunkels <[email protected]>, <[email protected]>
-Copyright (c) 2004,2006, Swedish Institute of Computer Science.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. Neither the name of the Institute nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.
-
---------------
-
 Dhcp.h
 Dhcp.cpp
 
@@ -164,25 +137,4 @@ Dns.cpp
 (c) Copyright 2009-2010 MCQN Ltd.
 Released under Apache License, version 2.0
 
---------------
-
-clock-arch.h
-clock-arch.c
- 
-Copyright (c) 2010 Adam Nielsen <[email protected]>
-All rights reserved.
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 ```

library.properties

@@ -3,7 +3,7 @@ author=Norbert Truchsess, maintainer Juraj Andrassy
 maintainer=Juraj Andrassy <[email protected]>
 sentence=Ethernet library for ENC28J60. Only include EthernetENC.h instead of Ethernet.h 
 paragraph=This is a modern version of the UIPEthernet library. EthernetENC library is compatible with all Arduino architectures with Arduino SPI library with transactions support. 
-url=https://github.com/jandrassy/EthernetENC
+url=https://github.com/jandrassy/EthernetENC/wiki
 architectures=*
 version=2.0
 category=Communication