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

Commit 57a69c7

Browse files
authored
fix: update project config (#173)
1 parent 981f3ae commit 57a69c7

File tree

4 files changed

+26
-74
lines changed

4 files changed

+26
-74
lines changed

.gitignore

+6-41
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,9 @@
1-
docs
2-
package-lock.json
3-
yarn.lock
4-
**/node_modules/
5-
**/*.log
6-
test/repo-tests*
7-
test/test-repo/datastore/*
8-
9-
# Logs
10-
logs
11-
*.log
12-
13-
coverage
14-
15-
# Runtime data
16-
pids
17-
*.pid
18-
*.seed
19-
20-
# Directory for instrumented libs generated by jscoverage/JSCover
21-
lib-cov
22-
23-
# Coverage directory used by tools like istanbul
24-
coverage
25-
26-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
27-
.grunt
28-
29-
# node-waf configuration
30-
.lock-wscript
31-
32-
build
33-
34-
# Dependency directory
35-
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
361
node_modules
37-
38-
lib
2+
build
393
dist
40-
test/test-repo/datastore
41-
init-default
42-
datastore-test
4+
.docs
5+
.coverage
6+
node_modules
7+
package-lock.json
8+
yarn.lock
439
.vscode
44-
types

README.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
11
# datastore-level <!-- 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-datastore-level.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-datastore-level)
7-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-datastore-level/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-datastore-level/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-datastore-level/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-datastore-level/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
87

98
> Datastore implementation with level(up|down) backend
109
1110
## Table of contents <!-- omit in toc -->
1211

1312
- [Install](#install)
13+
- [Browser `<script>` tag](#browser-script-tag)
1414
- [Usage](#usage)
1515
- [Browser Shimming Leveldown](#browser-shimming-leveldown)
1616
- [Database names](#database-names)
17-
- [Contribute](#contribute)
1817
- [License](#license)
19-
- [Contribute](#contribute-1)
18+
- [Contribute](#contribute)
2019

2120
## Install
2221

2322
```console
2423
$ npm i datastore-level
2524
```
2625

26+
### Browser `<script>` tag
27+
28+
Loading this module through a script tag will make it's exports available as `DatastoreLevel` in the global namespace.
29+
30+
```html
31+
<script src="https://unpkg.com/datastore-level/dist/index.min.js"></script>
32+
```
33+
2734
## Usage
2835

2936
```js
@@ -62,14 +69,6 @@ import browserStore = new LevelDatastore(
6269

6370
More information: [https://github.com/Level/level-js/blob/master/UPGRADING.md#new-database-prefix](https://github.com/Level/level-js/blob/99831913e905d19e5f6dee56d512b7264fbed7bd/UPGRADING.md#new-database-prefix)
6471

65-
## Contribute
66-
67-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-datastore-level/issues)!
68-
69-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
70-
71-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
72-
7372
## License
7473

7574
Licensed under either of
@@ -79,8 +78,12 @@ Licensed under either of
7978

8079
## Contribute
8180

82-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
81+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-datastore-level/issues).
82+
83+
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.
84+
85+
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).
8386

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

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

package.json

-16
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,6 @@
2727
},
2828
"type": "module",
2929
"types": "./dist/src/index.d.ts",
30-
"typesVersions": {
31-
"*": {
32-
"*": [
33-
"*",
34-
"dist/*",
35-
"dist/src/*",
36-
"dist/src/*/index"
37-
],
38-
"src/*": [
39-
"*",
40-
"dist/*",
41-
"dist/src/*",
42-
"dist/src/*/index"
43-
]
44-
}
45-
},
4630
"files": [
4731
"src",
4832
"dist",

test/index.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { interfaceDatastoreTests } from 'interface-datastore-tests'
1010
describe('LevelDatastore', () => {
1111
describe('initialization', () => {
1212
it('should default to a leveldown database', async () => {
13-
const levelStore = new LevelDatastore('init-default')
13+
const levelStore = new LevelDatastore(`${tempdir()}/init-default-${Date.now()}`)
1414
await levelStore.open()
1515

1616
expect(levelStore.db).to.be.an.instanceOf(Level)

0 commit comments

Comments
 (0)