Skip to content

Commit 35e8a8f

Browse files
committed
chore: initial commit
0 parents  commit 35e8a8f

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# @helia/unixfs <!-- omit in toc -->
2+
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)
5+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
7+
8+
> A Helia-compatible wrapper for UnixFS
9+
10+
## Table of contents <!-- omit in toc -->
11+
12+
- [Install](#install)
13+
- [Browser `<script>` tag](#browser-script-tag)
14+
- [API Docs](#api-docs)
15+
- [License](#license)
16+
- [Contribute](#contribute)
17+
18+
## Install
19+
20+
```console
21+
$ npm i @helia/unixfs
22+
```
23+
24+
### Browser `<script>` tag
25+
26+
Loading this module through a script tag will make it's exports available as `HeliaUnixfs` in the global namespace.
27+
28+
```html
29+
<script src="https://unpkg.com/@helia/unixfs/dist/index.min.js"></script>
30+
```
31+
32+
## API Docs
33+
34+
- <https://ipfs.github.io/helia/modules/_helia_unixfs.html>
35+
36+
## License
37+
38+
Licensed under either of
39+
40+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
41+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
42+
43+
## Contribute
44+
45+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
46+
47+
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.
48+
49+
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).
50+
51+
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.
52+
53+
[![](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)