@nomad-media/full 1.1.3 → 1.1.4

package/README.md

@@ -1,27 +1,62 @@
-## Build and Publish NPM
-To build the files, run the following command in the root directory of the project:
-```bash
-.\publish
+# Nomad Media Full
+This package contains the full version of the Nomad Media SDK. It includes all the methods of the SDK.
+
+## Minimum Requirements
+- Node.js 12.0.0
+
+## Installation
+To use the Nomad SDK, download the npm nomad-media-npm.
+
+```shell
+npm install @nomad-media/full
+```
+
+Then to import it, you can either use the default version, or the debug version. The difference is that the debug version isn't compressed and has more documentation and named parameters.
+
+To use the default version use:
+
+```javascript
+import NomadMediaSDK from "@nomad-media/full";
+```
+
+To use the debug version user:
+
+```javascript
+import NomadMediaSDK from "@nomad-media/full/debug";
 ```
 
-It will prompt you to enter your NPM username and password. After entering the credentials, the files will be uploaded to NPM.
+To initialize the sdk, call the NomadMediaSDK class as shown below:
 
-If you want to set up NPM to not prompt you for credentials every time, create a file called .npmrc in your home directory and add the following line to it:
-```.npmrc
-//registry.npmjs.org/:_authToken=<your-token>
+```javascript
+const SDK = NomadMediaSDK(config);
 ```
 
-## Minor and Major Version Bumps
-To bump the minor version, change `patch` in `call npm version patch` to `minor` in the package.json file. 
-To bump the major version, change `patch` in `call version patch` to `major` in the package.json file.
+## Configure Environmental Variables
+
+Follow this format for the config:
 
-## Testing
-To test a specific file in the test directory, run the following command in the root directory of the project:
-```bash
-npm test test/<file-name>
 ```
+const config = {
+    "username": "username",
+    "password": "password",
+    "serviceApiUrl": "serverApiUrl",
+    "apiType": "admin",
+    "debugMode": true
+};
+```
+serviceApiUrl: Specifies the url of the server you are trying to connect to.
+
+apiType: Specifies whether the function you are trying to run is **admin** or **portal**.
+
+debugMode: Specifies when running functions, whether of not to print api call information.
+
+You are now ready to use the SDK in your project.
+
+> 📘 Contact: Make sure to contact Nomad Media support to get username, password, and url for your enviromnent.
+
+> 🚧 Make sure to keep your configuration options secret and do not share them publicly.
+
+## Nomad SDK Documentation
 
-To test all the files in the test directory, run the following command in the root directory of the project:
-```bash
-npm test
-```
+- [Nomad SDK Modules](https://developer.nomad-cms.com/docs/nomad-api-modules)
+- [Nomad SDK NPM Samples](https://github.com/Nomad-Media/samples-js)

package/package.json

@@ -1,37 +1,19 @@
 {
 	"name": "@nomad-media/full",
-	"version": "1.1.3",
+	"version": "1.1.4",
 	"description": "Nomad Media NPM",
-	"main": "nomad-media-sdk.min.js",
+	"main": "dist/nomad-media-sdk.min.js",
 	"type": "module",
 	"exports": {
-		".": "./nomad-media-sdk.min.js",
-		"./debug": "./nomad-media-sdk-debug.js"
+		".": "./dist/nomad-media-sdk.min.js",
+		"./debug": "./dist/nomad-media-sdk-debug.js"
 	},
 	"files": [
-		"nomad-media-sdk.min.js",
-		"nomad-media-sdk-debug.js",
-		"README-npm.md"
+		"dist/nomad-media-sdk.min.js",
+		"dist/nomad-media-sdk-debug.js",
+		"README.md"
 	],
-	"scripts": {
-		"test": "mocha",
-		"docs": "swagger-jsdoc -d ./swaggerDef.cjs -o ./swaggerOutput.json ./sdk.js"
-	},
 	"dependencies": {
-		"chai": "^4.3.10",
-		"chai-as-promised": "^7.1.1",
 		"deep-equal": "^2.2.2"
-	},
-	"devDependencies": {
-		"grunt": "^1.6.1",
-		"grunt-contrib-clean": "^2.0.1",
-		"grunt-contrib-concat": "^2.1.0",
-		"grunt-contrib-uglify": "^5.2.2",
-		"grunt-eslint": "^24.3.0",
-		"grunt-text-replace": "^0.4.0",
-		"swagger-jsdoc": "^6.2.8"
-	},
-	"engines": {
-		"node": ">=12.0.0"
 	}
 }

package/README-npm.md

@@ -1,64 +0,0 @@
-
-# Minimum Requirements
-- Node.js 12.0.0
-
-## Installation
-To use the Nomad SDK, download the npm nomad-media-npm.
-
-```shell
-npm install @nomad-media/nomad-media
-```
-
-Then to import it, you can either use the default version, or the debug version. The difference is that the debug version isn't compressed and has more documentation and named parameters.
-
-To use the default version use:
-
-```javascript
-import NomadMediaSDK from "@nomad-media/nomad-media";
-```
-
-To use the debug version user:
-
-```javascript
-import NomadMediaSDK from "@nomad-media/nomad-media/debug";
-```
-
-To initialize the sdk, call the NomadMediaSDK class as shown below:
-
-```javascript
-const SDK = NomadMediaSDK(config);
-```
-
-## Configure Environmental Variables
-
-Follow this format for the config:
-
-```
-const config = {
-    "username": "username",
-    "password": "password",
-    "serviceApiUrl": "serverApiUrl",
-    "apiType": "admin",
-    "debugMode": true
-};
-```
-
-apiType: Specifies whether the function you are trying to run is **admin** or **portal**.
-
-debugMode: Specifies when running functions, whether of not to print api call information.
-
-You are now ready to use the SDK in your project.
-
-> 📘 Contact: Make sure to contact Nomad Media support to get username, password, and url for your enviromnent.
-
-> 🚧 Make sure to keep your configuration options secret and do not share them publicly.
-
-## Nomad SDK API Guide
-
-An overview of all of the Nomad SDK methods. Includes prameter details for the methods.
-
-[Nomad SDK References](https://developer.nomad-cms.com/docs/nomad-api-modules)
-
-## Nomad SDK NPM Samples
-
-[Nomad SDK NPM Samples](https://github.com/Nomad-Media/samples-js)