documentation

Author: chriscdn

README.md

@@ -27,19 +27,20 @@ $ yarn add @chriscdn/cs-rest
 Using unpkg CDN:
 
 ```html
+<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.min.js"></script>
 <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
-<script src="https://unpkg.com/browse/@chriscdn/cs-rest/lib/index.min.js"></script>
+<script src="https://unpkg.com/@chriscdn/cs-rest/lib/index.min.js"></script>
 ```
 
 ## Example
 
 Authenticate with a username and password and get the details of a node:
 
 ```js
-const {Session} = require('@chriscdn/cs-rest')
+const CSREST = require('@chriscdn/cs-rest')
 
 // session wraps an axios instance
-const session = new Session({
+const session = new CSREST.Session({
 	baseURL: 'https://.../cs.exe',
 	username: 'Admin',
 	password: '******'
@@ -52,7 +53,7 @@ const response = await session.get('/api/v1/nodes/2000')
 Authenticate with an `OTCSTicket`:
 
 ```js
-const session = auth({
+const session = new CSREST.Session({
 	baseURL: 'https://.../cs.exe',
 	otcsticket: '<token>'
 })
@@ -66,7 +67,7 @@ Content Server returns a fresh `OTCSTicket` with each successful API call.  The
 
 #### POST, PUT, & PATCH
 
-The OpenText Content Server REST API doesn't accept requests that use the `application/json` content type.  This means POST, PUT, & PATCH requests need to use a content type of `multipart/form-data`, which makes writing the request a little verbose.  For example, to create a new folder:
+The OpenText Content Server REST API doesn't accept requests that use the `application/json` content type.  This means post, put, & patch requests need to use a content type of `multipart/form-data`, which makes writing the request a little more verbose.  For example, to create a new folder:
 
 ```js
 const formData = new FormData()
@@ -123,6 +124,4 @@ See the `src/` directory for more examples.
 
 ## License
 
-[MIT](LICENSE)
-
-
+[MIT](LICENSE)

package.json

@@ -1,23 +1,22 @@
 {
 	"name": "@chriscdn/cs-rest",
-	"version": "1.0.3",
-	"description": "An authentication and wrapper for the OpenText Content Server REST API.",
+	"version": "1.0.4",
+	"description": "Simplified authentication and REST calls for OpenText Content Server.",
 	"main": "lib/index.cjs.js",
 	"module": "lib/index.es.js",
 	"unpkg": "lib/index.min.js",
 	"repository": "https://github.com/chriscdn/cs-rest",
 	"author": "Christopher Meyer",
 	"license": "MIT",
+	"scripts": {
+		"build": "rollup -c"
+	},
 	"dependencies": {
 		"@babel/runtime-corejs3": "^7.9.2",
 		"axios": "^0.19.2",
 		"form-data": "^3.0.0",
 		"lodash.get": "^4.4.2"
 	},
-	"keywords": [
-		"opentext",
-		"content server"
-	],
 	"devDependencies": {
 		"@babel/core": "^7.9.0",
 		"@babel/preset-env": "^7.9.0",
@@ -26,5 +25,11 @@
 		"@rollup/plugin-replace": "^2.3.1",
 		"rollup-plugin-babel": "^4.4.0",
 		"rollup-plugin-terser": "^5.3.0"
-	}
+	},
+	"keywords": [
+		"opentext",
+		"content-server",
+		"rest",
+		"axios"
+	]
 }