Update documentation and version bump.

CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.1.0-rc2] 2019-05-29
+### Added
+  - Split unit tests in separate test files.
+  - Added linting to CircleCI
+  - Added try/except blocks around plugin configuration code to improve installation and startup
+    experience when there are errors in the configuration.
+
+### Changed
+  - Fixed dictionary keys to reference 'apikey' consistently.
+  - Switch CircleCI from calling pytest directly to using Makefile.
+  - Dropped using sseclient-py in favour of btubbs sseclient.
+  - Corrected references to apikey configuration.
+
+### Removed
+
 ## [2.1.0-rc1] 2019-05-15
 ### Added
   - unit tests for more low level objects used by err-stackstorm.
@@ -13,7 +28,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   - updated makefile to be better adapted to CircleCI's build process.  (Still a work in progress)
   - numerious documentation updates to improve installation process for new users.
   - documented errbot's ACL features.
-  
+
 ### Removed
   - removed unused code for keyring and vault.
 

README.md

@@ -95,7 +95,7 @@ STACKSTORM = {
             'password': "my_password",
         },
         'token': "<User token>",
-        'key': '<API Key>'
+        'apikey': '<API Key>'
     },
     'rbac_auth': {
         'standalone': {},
@@ -113,7 +113,7 @@ Option | Description
 `api_auth.user.name` | Errbot username to authenticate with StackStorm.
 `api_auth.user.password` | Errbot password to authenticate with StackStorm.
 `api_auth.token` | Errbot user token to authenticate with StackStorm.  Used instead of a username/password pair.
-`api_auth.key` | Errbot API key to authenticate with StackStorm.  Used instead of a username/password pair or user token.
+`api_auth.apikey` | Errbot API key to authenticate with StackStorm.  Used instead of a username/password pair or user token.
 `timer_update` | Unit: seconds.  Default is *60*. Interval for err-stackstorm to the user token is valid.
 `rbac_auth.standalone` | Standalone authentication.
 `rbac_auth.clientside` | Clientside authentication, a chat user will supply StackStorm credentials to err-stackstorm via an authentication page.
@@ -202,10 +202,10 @@ original authentication method.
 err-stackstorm provides a way to associate the chat service user account with a StackStorm
 username/password or api token.
 
-This implementation is specific to err-stackstorm.  It is achieved by requesting a new 
-authentication session with err-stackstorm.  A Universally Unique Identifier (UUID) is generated 
-for the session and the chat user is invited to follow a URL to the authentication page hosted by 
-errbot.  For security reasons, the UUID is a one time use and is consumed when the page is 
+This implementation is specific to err-stackstorm.  It is achieved by requesting a new
+authentication session with err-stackstorm.  A Universally Unique Identifier (UUID) is generated
+for the session and the chat user is invited to follow a URL to the authentication page hosted by
+errbot.  For security reasons, the UUID is a one time use and is consumed when the page is
 accessed.  Any subsequent attempts to access the page will result in an error.
 
 The login page must be protected by TLS encryption and ideally require an ssl client certificate.
@@ -272,8 +272,8 @@ ACCESS_CONTROLS = {
 ```
 
 
-Getting the correct usernames to fill into `allowusers`/`denyusers` isn't obvious.  On a small 
-scale it's possibel to use the `!whoami` command to get the correct user account name.  For large 
+Getting the correct usernames to fill into `allowusers`/`denyusers` isn't obvious.  On a small
+scale it's possibel to use the `!whoami` command to get the correct user account name.  For large
 installation it'd make more sense to use a pre-defined pattern.
 
 Errbot matches `username` against the ACL definition.  This information isn't found easily in the Slack interface.  Use errbot's `!whoami`  command to find the value from the `nick` field which can be used with ACL definitions.

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="err-stackstorm",
-    version="2.0.0",
+    version="2.1.0-rc2",
     author="Err-StackStorm Plugin contributors",
     author_email="[email protected]",
     description="An Errbot plugin for StackStorm ChatOps.",