Skip to content

Commit

Permalink
Updating package name in readme (#6)
Browse files Browse the repository at this point in the history
* Updating readme for package name

* Package update
  • Loading branch information
pbradshawusc authored Oct 21, 2020
1 parent cfb5c5d commit a6c53f3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ KMS keys if encrypted).
## Installation

```bash
npm install osdu-service
npm install osdujs
```

## Usage
Expand All @@ -132,7 +132,7 @@ npm install osdu-service
Requires passing the OSDU API url and OSDU access token in the constructor

```javascript
const { SimpleOsduClient } = require('osdu-service');
const { SimpleOsduClient } = require('osdujs');

var osduClient = new SimpleOsduClient(process.env.OSDU_API_URL, process.env.OSDU_ACCESS_TOKEN);
```
Expand All @@ -156,7 +156,7 @@ Using the simple credential provider:
const {
AWSOsduClient,
AWSOsduSimpleCredentialProvider
} = require('osdu-service');
} = require('osdujs');

var osduClient = new AWSOsduClient({
api_url: process.env.OSDU_API_URL,
Expand All @@ -173,7 +173,7 @@ Using the AWS SSM credential provider:
const {
AWSOsduClient,
AWSOsduSSMCredentialProvider
} = require('osdu-service');
} = require('osdujs');

var osduClient = new AWSOsduClient({
api_url: process.env.OSDU_API_URL,
Expand All @@ -191,13 +191,13 @@ var osduClient = new AWSOsduClient({

### Using the OsduR2Service

Below are just a few usage examples using the OsduR2Service. See [integration and unit tests](https://github.com/pariveda/node-osdu-service/blob/master/tests) for more copmrehensive usage examples.
Below are just a few usage examples using the OsduR2Service. See [integration and unit tests](tests) for more copmrehensive usage examples.

Instantiating the service is as simple as passing in the client and the data partition you wish to operate on. For
more information regarding creating an OSDU client, please see [Instantiating the SimpleOsduClient](#instantiating-the-simpleosduclient) or [Instantiating the AwsOsduClient](#instantiating-the-awsosduclient)

```javascript
const { OsduR2Service } = require('osdu-service');
const { OsduR2Service } = require('osdujs');

var client = createOSDUClient();
var osduService = new OsduR2Service(client, 'opendes');
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "osdujs",
"version": "1.0.0",
"description": "Client to interact with OSDU applications",
"version": "1.0.1",
"description": "Nodejs client and service to interact with OSDU applications",
"repository": {
"type" : "git",
"url" : "https://github.com/pariveda/osdujs.git"
Expand Down
8 changes: 8 additions & 0 deletions release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Release Notes

## `1.0.1`

**Release Date**: 2020-12-21

Updates to Readme for package name accuracy and badges.

No functional updates.

## `1.0.0`

**Release Date**: 2020-12-21
Expand Down

0 comments on commit a6c53f3

Please sign in to comment.