Skip to content

Commit 7e28102

Browse files
committed
Readme feedback from review.
1 parent 39c7fff commit 7e28102

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# MyDataHelps REST API Node Quickstart
33

4-
This app is a demonstration of how to access the [MyDataHelps REST API](https://developer.mydatahelps.org/api/) using [Node.js](https://nodejs.org/en/). It gives an example of obtaining an access token and making a simple query to the API. You can use this app for reference, or modify it to test out your own API requests in a development environment.
4+
This app is a demonstration of how to access the [MyDataHelps REST API](https://developer.mydatahelps.org/) using [Node.js](https://nodejs.org/en/). It gives an example of obtaining an access token and making a simple query to the API. You can use this app for reference, or modify it to test out your own API requests in a development environment.
55

66
## Prerequisites
77

@@ -20,7 +20,12 @@ This is a command-line app in Node.js. To run the app:
2020
1. Install NodeJS and the Node Package Manager (npm).
2121
2. Clone this repository.
2222
3. Copy the file `dotenv.sample` and name the new copy `.env`.
23-
4. Edit the `.env` file and fill in your project ID, service account name, and private key. See **Prerequisites** above for more information. Be sure to include the begin/end tags “--BEGIN RSA PRIVATE KEY--“ and “--END RSA PRIVATE KEY--" in your private key.
23+
4. Edit the `.env` file and fill in your project ID, service account name, and private key. See **Prerequisites** above for how to get this information. Be sure to include the begin/end tags “--BEGIN RSA PRIVATE KEY--“ and “--END RSA PRIVATE KEY--" in your private key, and use line breaks, looking something like this:
24+
25+
```
26+
RKS_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n230703de230703de230703de\nb62b0e24b62b0e24b62b0e24\n...\n-----END RSA PRIVATE KEY-----"
27+
```
28+
2429
5. From the application directory, install the necessary npm libraries: `npm install`.
2530
6. Run the script: `node quickstart.js`.
2631

@@ -37,10 +42,6 @@ The access token is only valid for a few minutes, but you can copy/paste it into
3742

3843
## Troubleshooting
3944

40-
If you see an error when running the script, double-check the information in the Prerequisites, particularly the format of the private key. It should include the begin/end tags and line breaks, looking something like this:
41-
42-
```
43-
RKS_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n230703de230703de230703de\nb62b0e24b62b0e24b62b0e24\n...\n-----END RSA PRIVATE KEY-----"
44-
```
45+
If you see an error when running the script, double-check the information in the Prerequisites, particularly the format of the private key.
4546

46-
If you have trouble getting the app to work, feel free to [contact MyDataHelps Support](https://developer.mydatahelps.org/help/).
47+
If you have trouble getting the app to work, feel free to [contact MyDataHelps Support](https://developer.mydatahelps.org/help.html).

0 commit comments

Comments
 (0)