Refact. before adding OS X (1)

[usb-relay-hid.git] / README.md

diff --git a/README.md b/README.md
index 01fa7884c0c99d871e4f1641b2f10217439c31eb..4638b7728a557ede6b0863599a50e5248dd1e490 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,9 +11,9 @@ The big advantage of HID-based interface is that no kernel drivers and no simula
 The vendors currently offer only an API library for Windows, and only in binary form.
 
 We are not associated with the manufacturer(s) of these devices or author(s) of the original software offered by eBay sellers.
-Our intent is to make this device usable on Linux (and any other OS that supports libusb) as well as on 64-bit Windows.
+Our intent is to make this device work on Linux, 64-bit Windows and other platforms where we need it.
 
-The main project web page is on the [V-USB wiki](http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface "driver-less-usb-relays-hid-interface"). This is because the firmware of the device is based on [V-USB](http://www.obdev.at/products/vusb/index.html). V-USB enables amazingly simple and low-cost USB hardware solutions. This repository, however,  contains only the host side software.
+The main project web page is on the [V-USB wiki](http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface "driver-less-usb-relays-hid-interface"). This is because the firmware of the device is based on [V-USB](http://www.obdev.at/products/vusb/index.html). V-USB enables amazingly simple and low-cost USB hardware solutions. This repository contains only the host side software.
 
 
 
@@ -27,28 +27,17 @@ We could not locate any copyright information in the software package offered by
 Current state
 -------------
 
-A simple command-line utility for Linux (x86 or x64) and Windows.
+A simple command-line utility for Linux (x86 or x64), Apple OS X and Windows.
 This is enough for our own usage.
 
 - Windows version builds with VC++ and WDK 7.1.
 - Linux version builds with gcc and libusb v. 0.1. Tested on RH and Ubuntu.
+- OS-X 10.9+ version builds with Xcode and plain IOKit libraries. 
 
 
-To do:
--------
-
- * Reconstruct the API library, which will be binary compatible with the original software package, and minimal decent documentation.
- * Move the Linux variant to newer libusb version (1.x)
- * Make bindings for Python and Java
- * Maybe, reconstruct the GUI utility
- * Maybe, port the Windows variant to GNU (mingw) toolchain
- 
-The original API library does not handle hot-plug and removal of USB devices. The command-line utility isn't affected by hot plug/removal, but GUI clients of the library will need to re-enumerate the devices or react to PnP events in OS-specific way. Caller must provide locking in case of accessing the library from multiple threads.
-
+TO-DOs, bugs and more
+----------------------
 
-Misc.
------
+This is in the wiki and issues in the [Github project](http://git.io/bGcxrQ).
 
-Related projects:
 
-[USB Relay](https://github.com/johannesk/usb-relay)  by Johannes Krude - complete project with hardware and firmware, based on V-USB, but not HID - so requires a driver.