diff --git a/README.md b/README.md index 2f75fab..e7eb3e3 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ # blockstore-core -[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io) -[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) -[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs) +[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) +[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech) [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-blockstore-core.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-blockstore-core) -[![CI](https://img.shields.io/github/workflow/status/ipfs/js-blockstore-core/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-blockstore-core/actions/workflows/js-test-and-release.yml) +[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-blockstore-core/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-blockstore-core/actions/workflows/js-test-and-release.yml?query=branch%3Amaster) > Contains various implementations of the API contract described in interface-blockstore ## Table of contents - [Install](#install) + - [Browser ` +``` + ## Implementations - Base: [`src/base`](src/base.js) @@ -62,13 +70,9 @@ import { MemoryBlockstore } from 'blockstore-core/memory' const store = new MemoryBlockstore() ``` -## Contribute - -Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)! - -This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). +## API Docs -[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) +- ## License @@ -79,8 +83,12 @@ Licensed under either of ## Contribute -Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)! +Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-blockstore-core/issues). + +Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general. + +Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). -This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) diff --git a/package.json b/package.json index de80c14..157aa9a 100644 --- a/package.json +++ b/package.json @@ -167,20 +167,21 @@ "test:firefox": "aegir test -t browser -- --browser firefox", "test:firefox-webworker": "aegir test -t webworker -- --browser firefox", "test:electron-main": "aegir test -t electron-main", - "dep-check": "aegir dep-check" + "dep-check": "aegir dep-check", + "docs": "aegir docs" }, "dependencies": { "err-code": "^3.0.1", - "interface-blockstore": "^3.0.0", + "interface-blockstore": "^4.0.0", "interface-store": "^3.0.0", - "it-all": "^1.0.4", - "it-drain": "^1.0.4", - "it-filter": "^1.0.2", - "it-take": "^1.0.1", - "multiformats": "^10.0.0" + "it-all": "^2.0.0", + "it-drain": "^2.0.0", + "it-filter": "^2.0.0", + "it-take": "^2.0.0", + "multiformats": "^11.0.0" }, "devDependencies": { - "aegir": "^37.5.1", - "interface-blockstore-tests": "^3.0.0" + "aegir": "^37.9.0", + "interface-blockstore-tests": "^4.0.0" } }