logos-messaging/go-multiaddr
1
0
Fork 0
mirror of https://github.com/logos-messaging/go-multiaddr.git synced 2026-01-04 05:53:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #27 from RichardLitt/feature/readme

Browse Source 
Added badges, contribute, license, and fixed addr to ma
This commit is contained in:
Jakub Sztandera 2016-10-21 20:57:32 +02:00 committed by GitHub
commit b23eb95805
3 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -4,9 +4,15 @@
[![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](http://github.com/multiformats/multiformats) [![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](http://github.com/multiformats/multiformats)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
> multiaddr implementation in go > [multiaddr](https://github.com/multiformats/multiaddr) implementation in go
This is a [multiaddr](https://github.com/multiformats/multiaddr) implementation in Go. Multiaddr is a standard way to represent addresses that:
- Support any standard network protocols.
- Self-describe (include protocols).
- Have a binary packed format.
- Have a nice string representation.
- Encapsulate well.
## Table of Contents ## Table of Contents
@ -54,7 +60,7 @@ m2.Equal(m1)
```go ```go
// get the multiaddr protocol description objects // get the multiaddr protocol description objects
addr.Protocols() m1.Protocols()
// []Protocol{ // []Protocol{
// Protocol{ Code: 4, Name: 'ip4', Size: 32}, // Protocol{ Code: 4, Name: 'ip4', Size: 32},
// Protocol{ Code: 17, Name: 'udp', Size: 16}, // Protocol{ Code: 17, Name: 'udp', Size: 16},

2
doc.go
View File

@ -3,7 +3,7 @@ Package multiaddr provides an implementation of the Multiaddr network
address format. Multiaddr emphasizes explicitness, self-description, and address format. Multiaddr emphasizes explicitness, self-description, and
portability. It allows applications to treat addresses as opaque tokens, portability. It allows applications to treat addresses as opaque tokens,
and to avoid making assumptions about the address representation (e.g. length). and to avoid making assumptions about the address representation (e.g. length).
Learn more at https://github.com/jbenet/multiaddr Learn more at https://github.com/multiformats/multiaddr
Basic Use: Basic Use:

2
interface.go
View File

@ -3,7 +3,7 @@ package multiaddr
/* /*
Multiaddr is a cross-protocol, cross-platform format for representing Multiaddr is a cross-protocol, cross-platform format for representing
internet addresses. It emphasizes explicitness and self-description. internet addresses. It emphasizes explicitness and self-description.
Learn more here: https://github.com/jbenet/multiaddr Learn more here: https://github.com/multiformats/multiaddr
Multiaddrs have both a binary and string representation. Multiaddrs have both a binary and string representation.