Updating README and adding CHANGELOG file

CHANGELOG.md

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+## v1.0.0 (2012-11-25)
+### JavaScript Driver (Core)
+* Implemented all the WireProtocol commands planned for 1.0.0 ([see spreadsheet](https://docs.google.com/spreadsheet/ccc?key=0Am63grtxc7bDdGNqX1ZPX2VoZlE2ZHZhd09lNDkzbkE))
+
+### Binding
+* Java Binding `jar` files created in `/binding/java/jars`
+* Bindings committed as _third party library_ into the Selenium project ([commit](https://code.google.com/p/selenium/source/detail?r=18187))
+
+### Tests
+* Java tests cover _just about_ what's needed
+* Python test are just a stub
+
+---

README.md

@@ -3,33 +3,41 @@
 Ghost Driver is a pure JavaScript implementation of the
 [WebDriver Wire Protocol](http://code.google.com/p/selenium/wiki/JsonWireProtocol)
 for [PhantomJS](http://phantomjs.org/).
-It's going to be a Remote WebDriver that uses PhantomJS as back-end.
+It's a Remote WebDriver that uses PhantomJS as back-end.
 
-## Status
+GhostDriver is designed to be integral part of PhantomJS itself, but it's developed in isolation and progress is tracked
+by this Repository.
 
-* Under development / almost ready for 1.0
-* **Code Hardening in progress**: before raising bugs, check if's a "not yet implemented" feature first
-* **~90%** of the WireProtocol currently implemented
-* Version 1.0 will implement all the commands EXCEPT the ones related with Mobile WebDrivers (see spreadsheet below)
-* **DEPENDS ON MY BRANCH OF PHANTOMJS**, as mentioned below in the **Requirements** section
+Current version is `"1.0.0"` ([changelog](https://github.com/detro/ghostdriver/blob/master/CHANGELOG.md)).
 
-You can monitor development progress at [this Google Spreadsheet](https://docs.google.com/spreadsheet/ccc?key=0Am63grtxc7bDdGNqX1ZPX2VoZlE2ZHZhd09lNDkzbkE).
+The project was created and is lead by [Ivan De Marino](https://github.com/detro).
 
 ## Requirements
 
 At the moment you need to compile [a specific version of PhantomJS](https://github.com/detro/phantomjs/tree/ghostdriver-dev)
-to run GhostDriver. This is because GhostDriver needed new features
-in PhantomJS to fulfill all the functionalities of the WebDriver _"protocol"_.
+to run GhostDriver.
+This is because GhostDriver needed new features in PhantomJS to fulfill all the functionalities
+of the WebDriver _"protocol"_.
+This is only temporary: **next version of PhantomJS stable release will include GhostDriver built in**.
 
 ### Checkout and Compile Ivan De Marino's PhantomJS `ghostdriver-dev` branch:
 
-1. Prepare your machine for building PhantomJS as documented [here](http://phantomjs.org/build.html)
-2. `git remote add detro https://github.com/detro/phantomjs.git`
-3. `git checkout -b detro-ghostdriver-dev remotes/detro/ghostdriver-dev`
-4. Compile as you would compile PhantomJS
+1. Prepare your machine for building PhantomJS as documented [here](http://phantomjs.org/build.html), then...
+2. Add `detro` remote to local PhantomJS repo: `git remote add detro https://github.com/detro/phantomjs.git`
+3. Checkout the `ghostdriver-dev` branch: `git checkout -b detro-ghostdriver-dev remotes/detro/ghostdriver-dev`
+4. Build: `./build.sh`
+5. Go make some coffee (this might take a while...)
+6. `phantomjs --webdriver=8080` to **launch PhantomJS in Remote WebDriver mode**
 
 ## How to use it
 
+Launching PhantomJS in Remote WebDriver mode it's simple:
+```bash
+$ phantomjs --webdriver=PORT
+```
+Once started, you can use any `RemoteWebDriver` implementation to send commands to it. I advice to take a look to the
+`/test` directory for examples.
+
 ### Run the tests
 
 Here I show how to clone this repo and kick start the (Java) tests. You need
@@ -38,21 +46,44 @@ to run them (I tested it with Java 7, but should work with Java 6 too).
 
 1. `git clone https://github.com/detro/ghostdriver.git`
 2. Configure `phantomjs_exec_path` inside `ghostdriver/test/config.ini` to point at the build of PhantomJS you just did
-3. Configure `phantomjs_driver_path` inside `ghostdriver/test/config.ini` to the absolute path of your clone of `ghostdriver/src/main.js`
-4. `cd ghostdriver/test; ./gradlew test`
+3. `cd ghostdriver/test; ./gradlew test`
 
 ### Run GhostDriver yourself and launch tests against that instance
 
-1. `phantomjs ghostdriver/src/main.js PORT`
+1. `phantomjs --webdriver=PORT`
 2. Configure `driver` inside `ghostdriver/test/config.ini` to point at the URL `http://localhost:PORT`
 3. `cd ghostdriver/test; ./gradlew test`
 
 ### Register GhostDriver with a Selenium Grid hub
 
 1. Launch the grid server, which listens on 4444 by default: `java -jar /path/to/selenium-server-standalone-2.25.0.jar -role hub`
-2. Register with the hub: `phantomjs ghostdriver/src/main.js 8080 http://127.0.0.1:4444`
+2. Register with the hub: `phantomjs --webdriver=8080 --webdriver-selenium-grid-hub=http://127.0.0.1:4444`
 3. Now you can use your normal webdriver client with `http://127.0.0.1:4444` and just request `browserName: phantomjs`
 
+## Project Directory Structure
+
+Here follows the output of the `tree` command, trimmed of files and "build directories":
+
+```bash
+.
+├── binding
+│   └── java
+│       ├── jars            <--- JARs containing Binding, related Source and related JavaDoc
+│       └── src             <--- Java Binding Source
+|
+├── src                     <--- GhostDriver JavaScript core source
+│   ├── request_handlers    <--- JavaScript "classes/functions" that handle HTTP Requests
+│   └── third_party         <--- Third party/utility code
+│       └── webdriver-atoms <--- WebDriver Atoms, automatically imported from the Selenium project
+|
+├── test
+│   ├── java
+│   │   └── src             <--- Java Tests
+│   └── python              <--- Python Tests
+|
+└── tools                   <--- Tools (import/export)
+```
+
 ## Presentation and Slides (old)
 
 In April 2012 I (Ivan De Marino) presented GhostDriver at the
@@ -61,25 +92,17 @@ In April 2012 I (Ivan De Marino) presented GhostDriver at the
 and
 [video](http://blog.ivandemarino.me/2012/05/01/Me-the-Selenium-Conference-2012).
 
-## Reasoning: pros and cons
-
-### Pros of using an Headless browser for your Selenium testing
-* Speed: makes development faster
-* Speed: makes THE developer happier
-* Speed: makes leaves more time for beer, video-games, cycling or whatever you fancy
-* ...
-
-### Cons of using an Headless browser for your Selenium testing
-* PhantomJS is not a "Real" Browser, but _"just"_ very very close to one
-
-## Contributions
+## Contributions and/or Bug Report
 
-You can contribute testing it and reporting bugs and issues, or submitting Pull Requests.
+You can contribute by testing GhostDriver, reporting bugs and issues, or submitting Pull Requests.
 Any **help is welcome**, but bear in mind the following base principles:
 
+* Issue reporting requires a reproducible example, otherwise will most probably be **closed withouth worning**
 * Squash your commits by theme: I prefer a clean, readable log
 * Maintain consistency with the code-style you are surrounded by
 * If you are going to make a big, substantial change, let's discuss it first
+* I **HATE** CoffeeScript: assume I'm going to laugh off any "contribution" that contains such _aberrating crap_!
+* Open Source is NOT a democracy (and I mean it!)
 
 ## License
 GhostDriver is distributed under [BSD License](http://www.opensource.org/licenses/BSD-2-Clause).