Skip to content

Commit 4d20a3e

Browse files
authored
docs: minor updates to README.md and package.json (#17)
1 parent 49e127e commit 4d20a3e

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Patch Javascript SDK
1+
# Patch JavaScript SDK
22

33
![Test](https://github.com/patch-technology/patch-node/workflows/Test/badge.svg)
44
[![npm version](https://badge.fury.io/js/%40patch-technology%[email protected])](https://www.npmjs.com/package/@patch-technology/patch)
55
[![Discord](https://img.shields.io/discord/733029448558837792)](https://discord.gg/M23NnGR)
66

7-
The official Javascript package for the [Patch API](https://www.usepatch.com)
7+
The official JavaScript package for the [Patch API](https://www.usepatch.com).
88

99
## Documentation
1010

@@ -26,7 +26,7 @@ yarn add @patch-technology/patch
2626

2727
### Requirements
2828

29-
- Node 10 +
29+
- Node 10+
3030

3131
## Usage
3232

@@ -156,50 +156,50 @@ patch.preferences.retrievePreferences({ page });
156156

157157
To build and test the package locally, run:
158158

159-
```
159+
```sh
160160
$ npm run build
161161
```
162162

163163
This will generate a `dist` folder with the compiled code. Next you want to link the package and use it in a different folder.
164164

165165
In the patch-node folder, run:
166166

167-
```
167+
```sh
168168
$ npm link
169169
```
170170

171171
Navigate to a different, empty folder:
172172

173-
```
173+
```sh
174174
$ cd ..
175175
$ mkdir test-patch-node
176176
$ cd test-patch-node
177177
```
178178

179179
In that repository, run the following command to use the locally built package:
180180

181-
```
181+
```sh
182182
$ npm link @patch-technology/patch
183183
```
184184

185185
This will create a `node_modules` directory in your test repository which will symlink to your locally built package. To test out the package, open a node REPL and import the package and run some queries.
186186

187-
```
187+
```sh
188188
$ node
189189
> const Patch = require('@patch-technology/patch')
190190
> Patch.default(process.env.SANDBOX_API_KEY).projects.retrieveProjects().then((response) => console.log(response))
191191
```
192192

193193
### Run the specs
194194

195-
Before running the tests, make sure you set the test API key! (please use test API keys and not production ones, they usually start with `key_test_`)
195+
Before running the tests, make sure you set the test API key! Please use test API keys and not production ones, they usually start with `key_test_`.
196196

197-
```
197+
```sh
198198
$ export SANDBOX_API_KEY=<PATCH_TEST_API_KEY>
199199
```
200200

201201
Then you are ready to run the tests:
202202

203-
```
203+
```sh
204204
$ npm run test
205205
```

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@patch-technology/patch",
33
"version": "1.2.4",
4-
"description": "Javascript wrapper for the Patch API",
4+
"description": "JavaScript wrapper for the Patch API",
55
"license": "MIT",
66
"repository": {
77
"type": "git",
@@ -49,15 +49,15 @@
4949
"dist"
5050
],
5151
"keywords": [
52+
"api",
53+
"carbon neutral",
54+
"carbon removal",
55+
"carbon sequestration",
5256
"carbon",
5357
"offset",
5458
"patch",
5559
"sustainability",
56-
"carbon neutral",
57-
"carbon removal",
58-
"carbon sequestration",
59-
"trees",
60-
"api"
60+
"trees"
6161
],
6262
"husky": {
6363
"hooks": {

0 commit comments

Comments
 (0)