feat: this module is now named ipld-block

vmx · vmx · commit 5a3bbde40c0c · 2019-05-09T21:39:47.000+02:00
This module was previously called `ipfs-block`. It is now maintained within IPLD.

BREAKING CHANGE: The symbol for comparing blocks changed

This means that if you are a user of this module, updating to this version
is also a breaking change for your module. Don't forgot to make the corresponding
version bump on your next release.
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
-# IPFS Block JavaScript Implementation
+# IPLD Block JavaScript Implementation
 
 [![](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/)
-[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![](https://img.shields.io/badge/project-IPLD-blue.svg?style=flat-square)](http://ipld.io/)
+[![](https://img.shields.io/badge/freenode-%23ipld-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipld)
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-[![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-block)](https://travis-ci.com/ipfs/js-ipfs-block)
-[![Coverage Status](https://coveralls.io/repos/github/ipfs/js-ipfs-block/badge.svg?branch=master)](https://coveralls.io/github/ipfs/js-ipfs-block?branch=master)
-[![Dependency Status](https://david-dm.org/ipfs/js-ipfs-block.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-block)
+[![Travis CI](https://flat.badgen.net/travis/ipld/js-ipld-block)](https://travis-ci.com/ipld/js-ipld-block)
+[![Coverage Status](https://coveralls.io/repos/github/ipld/js-ipld-block/badge.svg?branch=master)](https://coveralls.io/github/ipld/js-ipld-block?branch=master)
+[![Dependency Status](https://david-dm.org/ipld/js-ipld-block.svg?style=flat-square)](https://david-dm.org/ipld/js-ipld-block)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 ![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
 ![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)
 
-> [IPFS][ipfs] implementation of the Block data structure in JavaScript.
+> [IPLD][ipld] implementation of the Block data structure in JavaScript.
 
-**Block** - A block is a blob of binary data.
+**Block** - A block is a blob of binary data combined with a [CID].
 
 ## Lead Maintainer
 
@@ -41,21 +41,21 @@
 ### npm
 
 ```sh
-> npm install ipfs-block
+> npm install ipld-block
 ```
 
 ## Usage
 
 ### Node.js
 
 ```js
-const Block = require('ipfs-block')
+const Block = require('ipld-block')
 ```
 
 #### Example
 
 ```js
-const Block = require('ipfs-block')
+const Block = require('ipld-block')
 
 // create a block
 const block = new Block(new Buffer('hello world'), cid)
@@ -70,24 +70,24 @@ it and use with your favourite bundler without having to adjust asset management
 process.
 
 ```js
-const Block = require('ipfs-block')
+const Block = require('ipld-block')
 ```
 
 ### Browser: `<script>` Tag
 
-Loading this module through a script tag will make the `IpfsBlock` obj available in
+Loading this module through a script tag will make the `IpldBlock` obj available in
 the global namespace.
 
 ```html
-<script src="https://unpkg.com/ipfs-block/dist/index.min.js"></script>
+<script src="https://unpkg.com/ipld-block/dist/index.min.js"></script>
 <!-- OR -->
-<script src="https://unpkg.com/ipfs-block/dist/index.js"></script>
+<script src="https://unpkg.com/ipld-block/dist/index.js"></script>
 ```
 
 ## API
 
 ```js
-const Block = require('ipfs-block')
+const Block = require('ipld-block')
 ```
 
 ### Block
@@ -106,12 +106,13 @@ The raw data of the block. Its format matches whatever was provided in its const
 
 The cid of the block.
 
-[ipfs]: https://ipfs.io
-[multihash]: https://github.com/jbenet/js-multihash
+[ipld]: https://ipld.io/
+[multihash]: https://github.com/multiformats/js-multihash
+[CID]: https://github.com/multiformats/js-cid
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-block/issues)!
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipld/js-ipld-block/issues)!
 
 This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "ipfs-block",
+  "name": "ipld-block",
   "version": "0.8.0",
-  "description": "JavaScript Implementation of IPFS Block",
+  "description": "JavaScript Implementation of IPLD Block",
   "leadMaintainer": "Volker Mische <volker.mische@gmail.com>",
   "main": "src/index.js",
   "scripts": {
@@ -23,16 +23,16 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ipfs/js-ipfs-block.git"
+    "url": "git+https://github.com/ipld/js-ipld-block.git"
   },
   "keywords": [
-    "IPFS"
+    "IPLD"
   ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/ipfs/js-ipfs-block/issues"
+    "url": "https://github.com/ipld/js-ipld-block/issues"
   },
-  "homepage": "https://github.com/ipfs/js-ipfs-block#readme",
+  "homepage": "https://github.com/ipld/js-ipld-block#readme",
   "devDependencies": {
     "aegir": "^18.2.0",
     "chai": "^4.2.0"
diff --git a/src/index.js b/src/index.js
@@ -54,4 +54,4 @@ class Block {
   }
 }
 
-module.exports = withIs(Block, { className: 'Block', symbolName: '@ipfs/js-ipfs-block/block' })
+module.exports = withIs(Block, { className: 'Block', symbolName: '@ipld/js-ipld-block/block' })

Original file line number	Diff line number	Diff line change
`@@ -54,4 +54,4 @@ class Block {`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
`57`		`-module.exports = withIs(Block, { className: 'Block', symbolName: '@ipfs/js-ipfs-block/block' })`
	`57`	`+module.exports = withIs(Block, { className: 'Block', symbolName: '@ipld/js-ipld-block/block' })`