Update documentation (#35)

Reference the new website and user guide in the README
rvesse · Dec 3, 2015 · 47097e2 · 47097e2
1 parent 9221a37
commit 47097e2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@
 - Bug Fixes
     - `ManCommandUsageGenerator` could incorrectly indent the arguments portion of the options list if both visible and hidden options are present
     - Man help output could fail in the options section if there were no visible options but some hidden options present
+- Annotation Changes
+   - Marked defunct fields of `@Arguments` annotation as deprecated
+   - Marked various annotations as `@Documented` so they are included in JavaDoc output
 
 ## 2.1.0
 

diff --git a/README.md b/README.md
@@ -12,6 +12,12 @@ Airline 2 contains significant breaking changes from Airline 1.x, please see [Mi
 
 Airline 2.1 contains some further minor breaking changes that should only affect advanced users, again please see [Migrating.md](Migrating.md) in this folder for more details on how to migrate code forward.  Some users may need to add additional Maven dependencies if they were using help formats other than the basic CLI help.
 
+## User Guide
+
+We're currently working on our new website which will eventually include a comprehensive user guide though is currently a work in progress.
+
+You can find the website at [http://rvesse.github.io/airline/](http://rvesse.github.io/airline/)
+
 ## Usage
 
 To use airline you need to add a dependency to it to your own code, the Maven artifacts are described later in this file.