Version Bump v3.0.6: Added troubleshooting section

Author: thinkingserious

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [3.0.6] - 2016-07-26
+### Added
+- [Troubleshooting](https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md) section
+
 ## [3.0.5] - 2016-07-20
 ### Added
 - README updates

CONTRIBUTING.md

@@ -102,7 +102,7 @@ touch Example.java
 Add the example you want to test to Example.java, including the headers at the top of the file.
 
 ``` bash
-javac -classpath ../repo/com/sendgrid/3.0.4/sendgrid-3.0.4-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/3.0.4/sendgrid-3.0.4-jar.jar:. Example
+javac -classpath ../repo/com/sendgrid/3.0.6/sendgrid-3.0.6-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/3.0.6/sendgrid-3.0.6-jar.jar:. Example
 ```
 
 <a name="understanding_the_codebase"></a>

README.md

@@ -38,7 +38,7 @@ Add the following to your build.gradle file in the root of your project.
 ...
 dependencies {
   ...
-  compile 'com.sendgrid:sendgrid-java:3.0.5'
+  compile 'com.sendgrid:sendgrid-java:3.0.6'
 }
 
 repositories {
@@ -63,7 +63,7 @@ mvn install
 
 You can just drop the jar file in. It's a fat jar - it has all the dependencies built in.
 
-[sendgrid-java.jar](http://repo1.maven.org/maven2/com/sendgrid/sendgrid-java/3.0.5/sendgrid-java-3.0.5-jar.jar)
+[sendgrid-java.jar](http://repo1.maven.org/maven2/com/sendgrid/sendgrid-java/3.0.6/sendgrid-java-3.0.6-jar.jar)
 
 ```java
 import com.sendgrid.*;
@@ -190,6 +190,10 @@ Quick links:
 - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#cla)
 - [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
 
+# Troubleshooting
+
+Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-java/blob/master/TROUBLESHOOTING.md) for common library issues.
+
 # About
 
 sendgrid-java is guided and supported by the SendGrid [Developer Experience Team](mailto:[email protected]).

TROUBLESHOOTING.md

@@ -0,0 +1,91 @@
+If you have a non-library SendGrid issue, please contact our [support team](https://support.sendgrid.com).
+
+If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-java/issues).
+
+
+## Table of Contents
+
+* [Migrating from v2 to v3](#migrating)
+* [Continue Using v2](#v2)
+* [Testing v3 /mail/send Calls Directly](#testing)
+* [Versions](#versions)
+* [Environment Variables and Your SendGrid API Key](#environment)
+* [Using the Package Manager](#package-manager)
+
+<a name="migrating"></a>
+## Migrating from v2 to v3
+
+Please review [our guide](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html) on how to migrate from v2 to v3.
+
+<a name="v2"></a>
+## Continue Using v2
+
+[Here](https://github.com/sendgrid/sendgrid-java/tree/b64988f85474e04e9d75e17860d64ffacda1cdff) is the last working version with v2 support.
+
+### via Maven w/ Gradle
+
+Add the following to your build.gradle file in the root of your project.
+
+```groovy
+...
+dependencies {
+  ...
+  compile 'com.sendgrid:sendgrid-java:2.2.2'
+}
+
+repositories {
+  mavenCentral()
+}
+...
+```
+
+### via jar file
+
+You can just drop the jar file in. It's a fat jar - it has all the dependencies built in.
+
+[sendgrid-java.jar](http://repo1.maven.org/maven2/com/sendgrid/sendgrid-java/2.2.2/sendgrid-java-2.2.2-jar.jar)
+
+<a name="testing"></a>
+## Testing v3 /mail/send Calls Directly
+
+[Here](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/curl_examples.html) are some cURL examples for common use cases.
+
+<a name="versions"></a>
+## Versions
+
+We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guarenteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-java/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-java/releases) section.
+
+<a name="environment"></a>
+## Environment Variables and Your SendGrid API Key
+
+All of our examples assume you are using [environment variables](https://github.com/sendgrid/sendgrid-java#setup-environment-variables) to hold your SendGrid API key.
+
+If you choose to add your SendGrid API key directly (not recommended):
+
+`System.getenv("SENDGRID_API_KEY")`
+
+becomes
+
+`"SENDGRID_API_KEY"`
+
+In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual SendGrid API Key.
+
+<a name="package-manager"></a>
+## Using the Package Manager
+
+We upload this library to [Maven](http://repo1.maven.org/maven2/com/sendgrid/sendgrid-java/) whenever we make a release. This allows you to use [maven and gradle](https://maven.apache.org/) for easy installation.
+
+In most cases we recommend you download the latest version of the library, but if you need a different version, please use:
+
+```groovy
+...
+dependencies {
+  ...
+  compile 'com.sendgrid:sendgrid-java:X.X.X'
+}
+
+repositories {
+  mavenCentral()
+}
+...
+```

build.gradle

@@ -17,7 +17,7 @@ apply plugin: 'maven'
 apply plugin: 'signing'
 
 group         = 'com.sendgrid'
-version       = '3.0.5'
+version       = '3.0.6'
 ext.packaging = 'jar'
 
 allprojects {

pom.xml

@@ -9,7 +9,7 @@
     <groupId>com.sendgrid</groupId>
     <artifactId>sendgrid-java</artifactId>
     <name>SendGrid Java helper library</name>
-    <version>3.0.5</version>
+    <version>3.0.6</version>
     <description>This Java module allows you to quickly and easily send emails through SendGrid using Java.</description>
     <url>https://github.com/sendgrid/sendgrid-java</url>
     <licenses>