add readme

This commit is contained in:
encrypt 2015-03-31 20:01:03 +02:00
parent e42f31c3e1
commit aeec24d442

26
README.md Normal file
View file

@ -0,0 +1,26 @@
etherswitch
===========
etherswitch is a simple daemon to control a toggle switch attached to a router.
How to use it
-------------
* Get a router
* Install OpenWRT
* Install etherswitch
* Configure etherswitch
* Get an ethernet cable and a toggle switch
* Cross RX+ and TX+
* Attach RX- and TX- to the toggle switch (or viceversa)
![muciaccia](http://i.imgur.com/7qWVZPj.png)
TODO
----
* Make a package for OpenWRT
* Re-introduce the possibility to use it with physical ethernet interface (without using ip)
* Write a real readme