Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
dms3
go-dms3-routing
Commits
462015cf
Unverified
Commit
462015cf
authored
May 05, 2018
by
Steven Allen
Committed by
GitHub
May 05, 2018
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #4 from ipfs/fix/3
fix the documentation
parents
f1c410ca
21c5e942
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
7 deletions
+39
-7
README.md
README.md
+39
-7
No files found.
README.md
View file @
462015cf
...
...
@@ -3,7 +3,6 @@
[
![
](
https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square
)
](http://ipn.io)
[
![
](
https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square
)
](http://ipfs.io/)
[
![standard-readme compliant
](
https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square
)
](https://github.com/RichardLitt/standard-readme)
[
![GoDoc
](
https://godoc.org/github.com/ipfs/go-ipfs-routing?status.svg
)
](https://godoc.org/github.com/ipfs/go-ipfs-routing)
[
![Build Status
](
https://travis-ci.org/ipfs/go-ipfs-routing.svg?branch=master
)
](https://travis-ci.org/ipfs/go-ipfs-routing)
> go-ipfs-routing provides go-libp2p-routing implementations used in go-ipfs.
...
...
@@ -17,27 +16,60 @@
## Install
`go-ipfs-routing`
works like a regular Go
module
:
`go-ipfs-routing`
works like a
set of
regular Go
packages
:
```
> go get github.com/ipfs/go-ipfs-routing
> go get github.com/ipfs/go-ipfs-routing
/...
```
This module uses
[
Gx
](
https://github.com/whyrusleeping/gx
)
to manage dependencies. You can use
`make all`
to build it with the
`gx`
dependencies.
This module uses
[
Gx
](
https://github.com/whyrusleeping/gx
)
to manage
dependencies. You can use
`make all`
to build it with the
`gx`
dependencies.
## Usage
This repo contains 3 different packages.
### Mock
[
![GoDoc
](
https://godoc.org/github.com/ipfs/go-ipfs-routing/mock?status.svg
)
](https://godoc.org/github.com/ipfs/go-ipfs-routing/mock)
```
import "github.com/ipfs/go-ipfs-routing/mock"
```
Mock is a fake router useful for tests. It provides a mock client that
implements the
`IpfsRouting`
interface and a mock server from which the client
retrieves routing records.
### Offline
[
![GoDoc
](
https://godoc.org/github.com/ipfs/go-ipfs-routing/offline?status.svg
)
](https://godoc.org/github.com/ipfs/go-ipfs-routing/offline)
```
import "github.com/ipfs/go-ipfs-routing/offline"
```
Offline is an offline router that can put and get records to and from a local
`Datastore`
but can't retrieve them from the network.
### None
[
![GoDoc
](
https://godoc.org/github.com/ipfs/go-ipfs-routing/none?status.svg
)
](https://godoc.org/github.com/ipfs/go-ipfs-routing/none)
```
import "github.com/ipfs/go-ipfs-routing"
import "github.com/ipfs/go-ipfs-routing
/none
"
```
Check the
[
GoDoc documentation
](
https://godoc.org/github.com/ipfs/go-ipfs-routing
)
None is a router no-op router that doesn't do anything. Puts always succeed and
lookups always fail.
## Contribute
PRs accepted.
Small note: If editing the README, please conform to the
[
standard-readme
](
https://github.com/RichardLitt/standard-readme
)
specification.
Small note: If editing the README, please conform to the
[
standard-readme
](
https://github.com/RichardLitt/standard-readme
)
specification.
## License
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment