Skip to content

Commit 9ff2bd3

Browse files
committed
[docs] Complete migration docs in README
1 parent 8ece668 commit 9ff2bd3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -152,14 +152,19 @@ The `ipfs` [command-line Client documentation](https://ipfs.io/docs/commands/) m
152152
* The Python package has been renamed from `ipfsapi` to `ipfshttpclient`
153153
* The PIP module has been renamed from `ipfsapi` to `ipfshttpclient` (please update your requirement files)
154154
* The `client.*_pyobj` family of functions has been dropped due to security concerns
155+
* The `client.bitswap.unwant` method has been dropped – it's endpoint has been removed by *go-ipfs*
156+
* The `client.files.file_ls` method has been dropped – deprecated for a long time, use `client.ls` instead
155157
* Passing a list of parameters to `client.add` will now fail, just pass several individual parameters instead
158+
* Some functions that may also return multiple items, will now also return a list when returning only a single item (don't worry about it unless it actually breaks for you)
156159
* The API deamon location is now described using MultiAddr, hence rather then doing `ipfshttpclient.connect(host, port)` to pass the network address parameters, use:
157160
* `ipfshttpclient.connect("/dns/<host>/tcp/<port>/http")` (for hostnames such as `localhost`)
158161
* `ipfshttpclient.connect("/ip4/<IP-address>/tcp/<port>/http")` (for IPv4 addresses)
159162
* `ipfshttpclient.connect("/ip6/<IP-address>/tcp/<port>/http")` (for IPv6 addresses)
160163
* Use `…/https` rather then `…/http` to connect to the API deamon using HTTPS
161164
* The client now supports [keeping session contexts around between API calls](#usage), you probably should make use of this facility in your code
162165

166+
Thank you @AlibabasMerchant, @lordcirth and @radfish (in order of subjective contributions) for helping making this happen!
167+
163168
## Featured Projects
164169

165170
Projects that currently use py-ipfs-http-client. If your project isn't here, feel free to submit a PR to add it!

0 commit comments

Comments
 (0)