Skip to content

Commit

Permalink
docs: clean mentions of go-ipfs-api, go-ipfs-http-api
Browse files Browse the repository at this point in the history
  • Loading branch information
hacdias committed Oct 13, 2023
1 parent a5668d2 commit 4c04311
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 86 deletions.
11 changes: 4 additions & 7 deletions core/coreapi/coreapi.go
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
/*
**NOTE: this package is experimental.**
Package coreapi provides direct access to the core commands in IPFS. If you are
embedding IPFS directly in your Go program, this package is the public
interface you should use to read and write files or otherwise control IPFS.
If you are running IPFS as a separate process, you should use `go-ipfs-api` to
work with it via HTTP. As we finalize the interfaces here, `go-ipfs-api` will
transparently adopt them so you can use the same code with either package.
**NOTE: this package is experimental.** `go-ipfs` has mainly been developed
as a standalone application and library-style use of this package is still new.
Interfaces here aren't yet completely stable.
If you are running IPFS as a separate process, you should use `client/rpc` to
work with it via HTTP.
*/
package coreapi

Expand Down
6 changes: 0 additions & 6 deletions docs/http-rpc-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

Kubo provides official HTTP RPC (`/api/v0`) clients for selected languages:

- [`js-kubo-rpc-client`](https://github.com/ipfs/js-kubo-rpc-client) - Official JS client for talking to Kubo RPC over HTTP
- [`go-ipfs-api`](https://github.com/ipfs/go-ipfs-api) - The go interface to ipfs's HTTP RPC - Follow https://github.com/ipfs/kubo/issues/9124 for coming changes.
- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`) - [`coreiface.CoreAPI`](https://pkg.go.dev/github.com/ipfs/boxo/coreiface#CoreAPI) implementation using HTTP RPC

## Recommended clients

| Language | Package Name | Github Repository |
|:--------:|:-------------------:|--------------------------------------------|
| JS | kubo-rpc-client | https://github.com/ipfs/js-kubo-rpc-client |
Expand Down
73 changes: 0 additions & 73 deletions package-list.json

This file was deleted.

0 comments on commit 4c04311

Please sign in to comment.