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

Commit 5bb5601

Browse files
authored
fix: update project config (#145)
Fixes readme badges, etc
1 parent e8d6902 commit 5bb5601

File tree

2 files changed

+25
-43
lines changed

2 files changed

+25
-43
lines changed

.gitignore

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

README.md

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

98
> Wrapper implementation for interface-datastore
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
- [BaseDatastore](#basedatastore)
@@ -25,6 +25,14 @@
2525
$ npm i datastore-core
2626
```
2727

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

3038
- Wrapper Implementations
@@ -91,8 +99,12 @@ Licensed under either of
9199

92100
## Contribute
93101

94-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
102+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-datastore-core/issues).
95103

96-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
104+
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.
105+
106+
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).
107+
108+
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.
97109

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

0 commit comments

Comments
 (0)