From 147dc719226bd465dc2d828761f5170546c4793e Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 23 May 2016 19:55:21 +0200 Subject: [PATCH 1/5] Added badges, contribute, license, and fixed addr to ma --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1d56f76..9ad28dc 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,14 @@ [![](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) -> 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 @@ -54,7 +59,7 @@ m2.Equal(m1) ```go // get the multiaddr protocol description objects -addr.Protocols() +ma.Protocols() // []Protocol{ // Protocol{ Code: 4, Name: 'ip4', Size: 32}, // Protocol{ Code: 17, Name: 'udp', Size: 16}, From 123bf94ac92940a6a61e34b127a5e021deb2ef79 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 16 Sep 2016 14:01:20 -0400 Subject: [PATCH 2/5] Changed jbenet to multiformats --- doc.go | 2 +- interface.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc.go b/doc.go index b82f0e5..d8c37b2 100644 --- a/doc.go +++ b/doc.go @@ -3,7 +3,7 @@ Package multiaddr provides an implementation of the Multiaddr network address format. Multiaddr emphasizes explicitness, self-description, and portability. It allows applications to treat addresses as opaque tokens, 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: diff --git a/interface.go b/interface.go index f8f2f6a..c68e4b4 100644 --- a/interface.go +++ b/interface.go @@ -3,7 +3,7 @@ package multiaddr /* Multiaddr is a cross-protocol, cross-platform format for representing 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. From fa328bf6147a55d483455e8183091144339be7a0 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 16 Sep 2016 14:09:23 -0400 Subject: [PATCH 3/5] Update naming --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ad28dc..774571e 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ m2.Equal(m1) ```go // get the multiaddr protocol description objects -ma.Protocols() +m1.Protocols() // []Protocol{ // Protocol{ Code: 4, Name: 'ip4', Size: 32}, // Protocol{ Code: 17, Name: 'udp', Size: 16}, @@ -69,9 +69,9 @@ ma.Protocols() #### En/decapsulate ```go -m.Encapsulate(ma.NewMultiaddr("/sctp/5678")) +ma.Encapsulate(ma.NewMultiaddr("/sctp/5678")) // -m.Decapsulate(ma.NewMultiaddr("/udp")) // up to + inc last occurrence of subaddr +ma.Decapsulate(ma.NewMultiaddr("/udp")) // up to + inc last occurrence of subaddr // ``` From 97dd3b3fbbc0b56f482b5b3cda30bfc307954462 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 16 Sep 2016 14:16:22 -0400 Subject: [PATCH 4/5] Fixed badge, added ToC, maintainers, install, contribute, license link --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 774571e..22cf604 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ > [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. From b53629c2626000701aaa72f3436cbe1e70b70dc5 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Sat, 17 Sep 2016 04:00:31 -0400 Subject: [PATCH 5/5] Back to m --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22cf604..5c168a6 100644 --- a/README.md +++ b/README.md @@ -70,9 +70,9 @@ m1.Protocols() #### En/decapsulate ```go -ma.Encapsulate(ma.NewMultiaddr("/sctp/5678")) +m.Encapsulate(ma.NewMultiaddr("/sctp/5678")) // -ma.Decapsulate(ma.NewMultiaddr("/udp")) // up to + inc last occurrence of subaddr +m.Decapsulate(ma.NewMultiaddr("/udp")) // up to + inc last occurrence of subaddr // ```