Documentation improvements (#15)

Author: btoron

README.md

@@ -15,20 +15,52 @@ In order to use this library you need to have access to an Oracle Field Service
 
    `npm install https://github.com/oracle-samples/ofs-proxy-js.git`    (when installing directly from GitHub)
 
+   `npm install @ofs-users/proxy`    (when installing from npm)
+
 2. To use the library in your code:
 
-   `import {OFSPlugin} from "@ofs_users/proxy"`
+   `import {OFS} from "@ofs-users/proxy"`
+
+## Functions implemented (may not be complete)
 
-## Functions implemented
+### Core: Activity Management
 
-`getActivity(activityId)`: Get activity details
+`getActivities()`: Get existing activities
 
 `updateActivity(activityId, activityData)`: Update activity details
 
+`createActivity(activityData)`: Create activity
+
+`deleteActivity(activityId)`: Delete activity
+
+`updateActivity(activityId, activityData)`: Update activity details
+
+### Core: Subscription Management
+
 `getSubscriptions()`: Get existing subscriptions
 
+### Core: User Management
+
+`getUsers()`: Get existing users
+
+`getUserDetails(userId)`: Get user details
+
+`getAllUsers()`: Get all users
+
+### Core: Plugin Management
+
 `importPlugins(file?, data?)`: Import plugin by path or via an XML string
 
+### Metadata: Property Management
+
+`getProperties()`: Get existing properties
+
+`getPropertyDetails(propertyId)`: Get property details
+
+`updateProperty(propertyId, propertyData)`: Update property details
+
+`createReplaceProperty(propertyData)`: Create or replace property
+
 ## Documentation and Examples
 
 Please see the `docs/` directory for documentation and a simple example
@@ -37,8 +69,11 @@ Please see the `docs/` directory for documentation and a simple example
 
 | Version | Comments |
 | ---------| ----------- |
-| 0.1| Added `getActivity`, `updateActivity`, `getSubscriptions` |
+| 0.1| Added `getActivityDetails`, `updateActivity`, `getSubscriptions` |
 | 1.1| Added `importPlugins` |
+| 1.2| Added `createActivity`, `deleteActivity` |
+| 1.6| Added `getUsers`, `getUserDetails`, `getAllUsers` |
+| 1.8| Added `getProperties`, `getPropertyDetails`, `updateProperty` `createReplaceProperty` |
 
 ## Contributing
 

docs/README.md

@@ -2,10 +2,17 @@
 
 | Function | URL |
 | ---------| ----------- |
-| `getActivity`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-get.html |
+| `getActivities`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-get.html |
+| `createActivity`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-post.html |
+| `deleteActivity`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-delete.html |
+| `getActivityDetails`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-get.html |
 | `updateActivity`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-patch.html
 | `getSubscriptions` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-events-subscriptions-get.html
 | `importPlugins` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-plugins-custom-actions-import-post.html
+| `getProperties` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-properties-get.html
+| `getPropertyDetails` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-properties-label-get.html
+| `updateProperty` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-properties-label-patch.html
+| `createReplaceProperty` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-properties-label-put.html
 
 ## Sample
 

package-lock.json

@@ -5,7 +5,7 @@
     ],
     "name": "@ofs-users/proxy",
     "type": "module",
-    "version": "1.8.0",
+    "version": "1.8.1",
     "description": "A Javascript proxy to access Oracle Field Service via REST API",
     "main": "dist/ofs.es.js",
     "module": "dist/ofs.es.js",