Skip to content

Commit

Permalink
docs: add kebab case breaking change (ipfs#1138)
Browse files Browse the repository at this point in the history
resolves ipfs#1137
  • Loading branch information
Alan Shaw authored Nov 5, 2019
1 parent 7007e5a commit c9a0e57
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,15 @@

### BREAKING CHANGES

* ```javascript
Promise<{oldCfg, newCfg}> ipfs.config.profile(name, opts)
* Configuration profiles API has changed:
```javascript
Promise<{oldCfg, newCfg}> ipfs.config.profile(name, opts)

// is now
Promise<{old, new}> ipfs.config.profiles.apply(name, opts)
```

Possibly contentious;
// is now
Promise<{old, new}> ipfs.config.profiles.apply(name, opts)
```

Adds `callbackify` as a dependency, see https://github.com/ipfs/js-ipfs/issues/2506
* Possibly contentious; Adds `callbackify` as a dependency, see https://github.com/ipfs/js-ipfs/issues/2506
for discussion.


Expand Down Expand Up @@ -138,7 +137,9 @@ for discussion.
<a name="35.0.0"></a>
# [35.0.0](https://github.com/ipfs/js-ipfs-http-client/compare/v34.0.0...v35.0.0) (2019-09-04)

### BREAKING CHANGES

Kebab case options (e.g. `wrap-with-directory`) are no longer supported in `ipfs.add`. Use camel case instead (e.g. `wrapWithDirectory`).

<a name="34.0.0"></a>
# [34.0.0](https://github.com/ipfs/js-ipfs-http-client/compare/v33.1.1...v34.0.0) (2019-08-29)
Expand Down

0 comments on commit c9a0e57

Please sign in to comment.