diff --git a/README.md b/README.md index 29cb9e8..3dafc4f 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,25 @@ -# someguy - -A [Delegated Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) server and client for all your routing needs. Ask `someguy` for directions. - -## Install - -```bash -go install github.com/ipfs-shipyard/someguy@latest -``` - - -## Build - -```bash -go build -o someguy -``` - -## Usage - -You can use `someguy` as a client or server. - -`someguy start` runs a Delegated Routing V1 server that proxies requests to the [IPFS Amino DHT](https://blog.ipfs.tech/2023-09-amino-refactoring/) and the [cid.contact](https://cid.contact) indexer node. - -If you don't want to run a server yourself, but want to query some other server, you can run `someguy ask` and choose any of the subcommands and ask for a provider, a peer, or even an IPNS record. - -For more details run `someguy --help`. +# someguy + +A [Delegated Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) server and proxy for all your routing needs. Ask `someguy` for directions. + +## Install + +```bash +go install github.com/ipfs/someguy@latest +``` + +## Build + +```bash +go build -o someguy +``` + +## Usage + +You can use `someguy` as a client (e.g. IPNI caching proxy) or server. + +By default, `someguy start` runs a Delegated Routing V1 server that proxies requests to the [IPFS Amino DHT](https://blog.ipfs.tech/2023-09-amino-refactoring/) and the [cid.contact](https://cid.contact) indexer (IPNI) node. + +If you don't want to run a server yourself, but want to query some other server, you can run `someguy ask` and choose any of the subcommands and ask for a provider, a peer, or even an IPNS record. + +For more details run `someguy --help`. diff --git a/go.mod b/go.mod index 6563b7d..834980f 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/ipfs-shipyard/someguy +module github.com/ipfs/someguy go 1.21