Skip to content

Commit 22c393e

Browse files
author
elkelk
committed
Update README
1 parent 57660ae commit 22c393e

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Domore - A Domo Enhancer
1+
Domore - A DOMO Enhancer
22
========================
33

4-
A drop-in replacement for the domo-sdk that adds additional much-needed functionality.
4+
A drop-in replacement / wrapper around the DOMO Node SDK to add needed functionality.
55

66

77
Installation
@@ -11,14 +11,6 @@ To install this pacakge in another project, use the following:
1111

1212
`npm install @searchdiscovery/domore`
1313

14-
However, since this is a private npm package, `npm install` will most likely fail when you try to install this package.
15-
16-
You will need to add the following line to your ~/.npmrc file:
17-
18-
`//registry.npmjs.org/:_authToken=get-the-token-from-1password`
19-
20-
**Important!!** You will also need to set up this token for any production environments that also will need to install the package (ie. Heroku). There is [documentation](https://medium.com/@oscargodson/npm-private-modules-with-heroku-25a171ce022e) on how to do this.
21-
2214

2315
Usage
2416
-----
@@ -38,4 +30,4 @@ Legacy
3830

3931
This library is based on some utility functions that grew organically over time. We've been updating as we go, but a lot of the code in
4032
the `lib` directory is still legacy. It may be there just as an example of how to use the actual Domo API. In that case, by all means
41-
please update that code to match the rest of this module.
33+
please update that code to match the rest of this module.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@searchdiscovery/domore",
33
"version": "0.5.2",
4-
"description": "A wrapper around the Domo server-side API to add much needed functionality.",
4+
"description": "A wrapper around the DOMO Node SDK to add needed functionality.",
55
"main": "index.js",
66
"scripts": {
77
"test": "mocha"

0 commit comments

Comments
 (0)