docs(improve-docs): fix markdown and docs

see #40

README.md

@@ -21,20 +21,20 @@ getAccessToken({
   // all the other config
   // ...
   realm: EMPLOYEES_REALM,
-  })
-  .then(token => {
-    // ...
-  });
+})
+.then(token => {
+  // ...
+});
 
 // instead use this:
 getAccessToken({
   // all the other config
   // ...
   queryParams: { realm: '/employees' }
-  })
-  .then(token => {
-    // ...
-  });
+})
+.then(token => {
+  // ...
+});
 ```
 See the [changelog](#changelog) for more information.
 
@@ -226,9 +226,11 @@ cleanMock();
 ## Changelog
 
 #### `2.0.0` - **BREAKING**
+
 The (zalando-specific) `realm` property was removed from `OAuthConfig`. Also, the corresponding constants (`SERVICES_REALM` and `EMPLYEES_REALM`) were removed. Instead, you can add the realm (and arbitrary other query parameters) via the `queryParams` property in `OAuthConfig`.
 
 #### `1.0.0` - **BREAKING**
+
 The signature of `requireScopesMiddleware` is now incompatible with previous versions, `precedenceFunction?` is now part of `precedenceOptions?`.
 
 ## License

src/oauth-tooling.ts

@@ -105,8 +105,8 @@ function requestAccessToken(bodyObject: any, authorizationHeaderValue: string,
 /**
  * Build url string to request access token, optionally with given query parameters.
  *
- * @param accessTokenEndpoint
- * @param queryParams
+ * @param accessTokenEndpoint string
+ * @param queryParams Object key value paris which will be added as query parameters
  * @returns {string}
  */
 function buildRequestAccessTokenUrl(accessTokenEndpoint: string, queryParams?: Object): string {