Skip to content
This repository was archived by the owner on Mar 23, 2023. It is now read-only.

Commit 0299bf5

Browse files
authored
deps!: update blockstore deps (#59)
Also publish api docs
1 parent f882313 commit 0299bf5

File tree

2 files changed

+32
-23
lines changed

2 files changed

+32
-23
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,38 @@
11
# blockstore-core <!-- omit in toc -->
22

3-
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4-
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5-
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
3+
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
4+
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
65
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-blockstore-core.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-blockstore-core)
7-
[![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)
6+
[![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)
87

98
> Contains various implementations of the API contract described in interface-blockstore
109
1110
## Table of contents <!-- omit in toc -->
1211

1312
- [Install](#install)
13+
- [Browser `<script>` tag](#browser-script-tag)
1414
- [Implementations](#implementations)
1515
- [Usage](#usage)
1616
- [BaseBlockstore](#baseblockstore)
1717
- [MemoryBlockstore](#memoryblockstore)
18-
- [Contribute](#contribute)
18+
- [API Docs](#api-docs)
1919
- [License](#license)
20-
- [Contribute](#contribute-1)
20+
- [Contribute](#contribute)
2121

2222
## Install
2323

2424
```console
2525
$ npm i blockstore-core
2626
```
2727

28+
### Browser `<script>` tag
29+
30+
Loading this module through a script tag will make it's exports available as `BlockstoreCore` in the global namespace.
31+
32+
```html
33+
<script src="https://unpkg.com/blockstore-core/dist/index.min.js"></script>
34+
```
35+
2836
## Implementations
2937

3038
- Base: [`src/base`](src/base.js)
@@ -62,13 +70,9 @@ import { MemoryBlockstore } from 'blockstore-core/memory'
6270
const store = new MemoryBlockstore()
6371
```
6472

65-
## Contribute
66-
67-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
68-
69-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
73+
## API Docs
7074

71-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
75+
- <https://ipfs.github.io/js-blockstore-core>
7276

7377
## License
7478

@@ -79,8 +83,12 @@ Licensed under either of
7983

8084
## Contribute
8185

82-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
86+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-blockstore-core/issues).
87+
88+
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.
89+
90+
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).
8391

84-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
92+
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.
8593

8694
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

package.json

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -167,20 +167,21 @@
167167
"test:firefox": "aegir test -t browser -- --browser firefox",
168168
"test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
169169
"test:electron-main": "aegir test -t electron-main",
170-
"dep-check": "aegir dep-check"
170+
"dep-check": "aegir dep-check",
171+
"docs": "aegir docs"
171172
},
172173
"dependencies": {
173174
"err-code": "^3.0.1",
174-
"interface-blockstore": "^3.0.0",
175+
"interface-blockstore": "^4.0.0",
175176
"interface-store": "^3.0.0",
176-
"it-all": "^1.0.4",
177-
"it-drain": "^1.0.4",
178-
"it-filter": "^1.0.2",
179-
"it-take": "^1.0.1",
180-
"multiformats": "^10.0.0"
177+
"it-all": "^2.0.0",
178+
"it-drain": "^2.0.0",
179+
"it-filter": "^2.0.0",
180+
"it-take": "^2.0.0",
181+
"multiformats": "^11.0.0"
181182
},
182183
"devDependencies": {
183-
"aegir": "^37.5.1",
184-
"interface-blockstore-tests": "^3.0.0"
184+
"aegir": "^37.9.0",
185+
"interface-blockstore-tests": "^4.0.0"
185186
}
186187
}

0 commit comments

Comments
 (0)