cdsclient-lib 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -7
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
# Cloudisense API Library
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
This library provides convenient access to the cloudisense backend service. It encapsulates communication mechanism for cloudisense's REST API as well as Real-time communication API.
|
|
3
|
+
## About
|
|
4
|
+
This library provides a convenient way to access the Cloudisense backend services. It encapsulates communication mechanisms for Cloudisense's REST API and Real-time Communication API.
|
|
7
5
|
|
|
8
|
-
This library is for use with the
|
|
6
|
+
This library is intended for use with the Cloudisense frontend React project.
|
|
9
7
|
|
|
8
|
+
---
|
|
10
9
|
|
|
11
10
|
## Usage
|
|
12
|
-
---
|
|
13
11
|
|
|
14
|
-
The following code snippet from
|
|
12
|
+
The following code snippet from a React-Redux project demonstrates how to establish a connection to the service from a client.
|
|
15
13
|
|
|
16
14
|
### Main Authentication Function
|
|
17
15
|
|
|
@@ -182,6 +180,8 @@ const initializeSocketClient = (dispatch, data) => {
|
|
|
182
180
|
|
|
183
181
|
3. Distribute compiled files for linux to react client project
|
|
184
182
|
|
|
183
|
+
> When building alongside `Cloudisense` main project folder
|
|
184
|
+
|
|
185
185
|
**Linux**
|
|
186
186
|
|
|
187
187
|
|
|
@@ -196,3 +196,6 @@ const initializeSocketClient = (dispatch, data) => {
|
|
|
196
196
|
TO DO
|
|
197
197
|
```
|
|
198
198
|
|
|
199
|
+
4. NPM
|
|
200
|
+
|
|
201
|
+
The library is hosted on NPM @ [https://www.npmjs.com/package/cdsclient-lib](https://www.npmjs.com/package/cdsclient-lib)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cdsclient-lib",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Api library for cloudisense react client",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"module": "dist/index.esm.js",
|
|
@@ -24,13 +24,13 @@
|
|
|
24
24
|
},
|
|
25
25
|
"repository": {
|
|
26
26
|
"type": "git",
|
|
27
|
-
"url": "https://github.com/
|
|
27
|
+
"url": "https://github.com/rajdeeprath/cloudisense-client-lib.git"
|
|
28
28
|
},
|
|
29
29
|
"keywords": ["cloudisense", "automation", "devops", "monitoring"],
|
|
30
30
|
"bugs": {
|
|
31
|
-
"url": "https://github.com/
|
|
31
|
+
"url": "https://github.com/rajdeeprath/cloudisense-client-lib/issues"
|
|
32
32
|
},
|
|
33
|
-
"homepage": "https://github.com/
|
|
33
|
+
"homepage": "https://github.com/rajdeeprath/cloudisense-client-lib#readme",
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@types/node": "^7.0.71",
|
|
36
36
|
"class-transformer": "^0.5.1",
|