Update documentation

Author: YonicDev

README.md

@@ -1,39 +1,55 @@
-<center>![gca-node logo][logo]</center>
+![gca-node logo][logo]
 
-gca-node is a NodeJS addon that adds Nintendo&trade; Wii U GameCube&trade; Adapter native support for NodeJS applications.
+gca-node is a NodeJS addon that adds Nintendo&reg; Wii U GameCube&trade; Adapter native support for NodeJS applications.
 
-Currently, gca-node is under testing and the final code development has not started.
+## Usage
 
-## Build guide
-
-**gca-node's initial_tests only build on Windows Vista and later versions.**
-
-gca-node final code will be able to be compiled on Windows 7 and later versions, OS X 10.8+ and most recent versions of Linux distros.
-
-*Windows XP and Windows Vista are not officially supported by gca-node, but it is possible to build the initial_tests directory by installing Windows XP C++ support on Visual Studio 2015.*
-*OS X 10.7 is not supported by gca-node, as well.*
+**gca-node currently only builds on Windows 7+**, although there is planned support for Linux and Mac OS.
+As of now, it can only be used on NW.js.
 
 ### Prerequisites
-  * **Visual Studio 2015** with standard C++ tools. **[Windows XP, Windows Vista]**: Windows XP C++ Support must also be installed.
-  * A built DLL of **[libusb 1.0.21][1]** or higher. It can be built from source on Visual Studio 2015 by opening the solution `libusb_2015.sln` within the `msvc` folder and building the project `libusb1.0 (dll)`. 
-    * You can also download a prebuilt DLL from the [libusb repository][2].
-  * **ElMassivo's Wii U GCN USB Driver**, either [downloding the latest release][3] or [building it from source][4]. Carefully follow all the instructions to install a new driver for the Wii U GameCube&trade; Adapter so that Windows may correctly configure it.
+  * **Visual Studio 2015** with standard C++ tools.
+  * **Node 7.5.0** or higher, with npm installed.
+  * **NW.js SDK version.**
+  * **Zadig**: You must use it to replace the HID driver installed on Windows for the adapter to a generic WinUSB one.
 
-### Build procedure
+### Building
 
  1. Download or clone the gca-node repository.
- 2. Create two directories within the `initial_tests\LibUSBTest<X>` folder called `lib` and `include`, where `<X>` is the number of test you want to try.
- 3. Copy both `libusb-1.0.dll` and `libusb-1.0.lib` you've just built inside the `lib` folder.
- 4. Copy the `libusb.h` from the downloaded libusb files to the `include` folder.
- 5. Open `LibUSBTest<X>.sln` and compile it.
- 6. The program should automatically copy the `libusb-1.0.dll` file within the executable program's folder. If it doesn't, Windows will report that the DLL is missing. You'll have to copy it manually to the folder where the executable is located.
-
-### Pre-execution setup
-1. Make sure you've installed **ElMassivo's Wii U GCN USB Driver** and changed the driver of the Wii U GameCube&trade; Adapter to WinUSB.
-2. However, **do *not* execute the built test program** while the driver is running, since the driver will have claimed the interface to connect with the adapter. If you have start it for testing purposes, please turn it off.
-
-[1]: https://sourceforge.net/projects/libusb/files/libusb-1.0/libusb-1.0.21/libusb-1.0.21.tar.bz2/download
-[2]: https://github.com/libusb/libusb/releases/download/v1.0.21/libusb-1.0.21.tar.bz2
-[3]: https://bitbucket.org/elmassivo/gcn-usb-adapter/downloads/WiiU-UsbSetup%202015-09-02.exe
-[4]: https://bitbucket.org/elmassivo/gcn-usb-adapter/src
+ 2. Install `node-gyp` globally (`npm install node-gyp -g`)
+ 3. Open the CLI inside the repository and execute `node-gyp rebuild`.
+
+### NW.js
+1. Open the CLI inside your NW.js project, and run the included `configure.bat` file to install the addon.
+2. Whenever you need to use gca-node, use an alias for require so that other NodeJS tools like webpack do not mistake it as a NodeJS module.
+   ```
+      var native_require = eval('require');
+      gca_node = native_require('gca-node.node')
+   ```
+
+## gca-node API
+
+### Setup()
+Detects the first Nintendo&reg; Wii U GameCube&trade; Adapter connected in your computer.
+Returns 0 if the setup has detected one.
+
+### Load()
+Claims the interface to be used on the NodeJS application.
+Returns 0 if an interface has been succesfully claimed.
+
+### Read()
+TODO. Returns an object with the current status of the GameCube controller.
+
+### Request()
+Obtains debug information about the current status of the GameCube controllers.
+
+
+### Unload()
+Releases the interface so that it can be used by other applications.
+Returns 0 if succesful.
+
+### Shutdown()
+Closes the Nintendo&reg; Wii U GameCube&trade; Adapter so that it can be safely unplugged.
+Returns 0 if succesful.
+
 [logo]: http://i.imgur.com/quWt3jK.png