Skip to content

Commit 2ad621e

Browse files
authored
Readd changelog (#6)
1 parent 344d1eb commit 2ad621e

File tree

2 files changed

+55
-5
lines changed

2 files changed

+55
-5
lines changed

CHANGELOG.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [1.1.1] - 2020-09-01
11+
12+
### Security
13+
14+
- Resolve [CVE-2020-7660](https://github.com/advisories/GHSA-hxcc-f52p-wc94)
15+
16+
## [1.1.0] - 2020-08-19
17+
18+
### Added
19+
20+
- `project_id` optional field to `order` creation
21+
- `metadata` optional field to `order` creation
22+
- `project_id` optional field to `estimate` creation
23+
- changelog file
24+
25+
## [1.0.0] - 2020-07-31
26+
27+
### Added
28+
29+
- This is the first official release of Patch's Node library.
30+
31+
## [1.0.0-rc.2] - 2020-07-30
32+
33+
### Added
34+
35+
- Pre-commit styling with Prettier
36+
37+
### Changed
38+
39+
- Corrects readme usage instructions
40+
- Upgrades old version of superagent
41+
42+
### Removed
43+
44+
- Removes @babel/cli as a dependency
45+
46+
## [1.0.0-rc.1] - 2020-07-29
47+
48+
### Added
49+
50+
- Patch's first pre-release of our core javascript client library.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The official Javascript package for the [Patch API](https://www.usepatch.com)
88

99
## Documentation
1010

11-
For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml)
11+
For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com)
1212

1313
## Installation
1414

@@ -47,7 +47,7 @@ var patch = require('@patch-technology/patch').default('key_test_1234');
4747

4848
In Patch, orders represent a purchase of carbon offsets or negative emissions by mass. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
4949

50-
[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1orders/get)
50+
[API Reference](https://docs.usepatch.com/#/?id=orders)
5151

5252
#### Examples
5353

@@ -77,7 +77,7 @@ patch.orders.retrieveOrders({ page })
7777

7878
Estimates allow API users to get a quote for the cost of compensating a certain amount of CO2. When creating an estimate, an order in the `draft` state will also be created, reserving the allocation of a project for 5 minutes. If you don't place your draft order within those 5 minutes, the order will automatically be cancelled.
7979

80-
[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1estimates/get)
80+
[API Reference](https://docs.usepatch.com/#/?id=estimates)
8181

8282
#### Examples
8383

@@ -99,7 +99,7 @@ patch.estimates.retrieveEstimates({ page });
9999

100100
Projects are the ways Patch takes CO2 out of the air. They can represent reforestation, enhanced weathering, direct air carbon capture, etc. When you place an order via Patch, it is allocated to a project.
101101

102-
[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1projects/get)
102+
[API Reference](https://docs.usepatch.com/#/?id=projects)
103103

104104
#### Examples
105105

@@ -117,7 +117,7 @@ patch.projects.retrieveProjects({ page });
117117

118118
Preferences are how you route your orders in Patch. If you don't have a preference, Patch will allocate your order to the least expensive option. If you do have a preference, all of your orders will be sent to that project. You can set your preferences via API, or through the [Patch Dashboard](https://dashboard.usepatch.com/projects).
119119

120-
[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1preferences/post)
120+
[API Reference](https://docs.usepatch.com/#/?id=preferences)
121121

122122
#### Examples
123123

0 commit comments

Comments
 (0)