-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add travis file and configure build scripts
- Loading branch information
1 parent
6429c6c
commit 5a25c87
Showing
10 changed files
with
126 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
node_modules | ||
*.lcov | ||
.nyc_output | ||
*.log | ||
package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# ipfs-unixfs JavaScript Implementation <!-- omit in toc --> | ||
|
||
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) | ||
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) | ||
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) | ||
[![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs)](https://travis-ci.com/ipfs/js-ipfs-unixfs) | ||
[![Codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-unixfs) | ||
[![Deps](https://david-dm.org/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs) | ||
[![Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) | ||
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square) | ||
![](https://img.shields.io/badge/Node.js-%3E%3D8.0.0-orange.svg?style=flat-square) | ||
|
||
> JavaScript implementation of IPFS' UnixFS (a Unix FileSystem files representation on top of a MerkleDAG) | ||
The UnixFS spec can be found inside the [ipfs/specs repository](http://github.com/ipfs/specs) | ||
|
||
## Lead Maintainer <!-- omit in toc --> | ||
|
||
[Alex Potsides](https://github.com/achingbrain) | ||
|
||
## Table of Contents <!-- omit in toc --> | ||
|
||
- [Install](#install) | ||
- [npm](#npm) | ||
- [Use in Node.js](#use-in-nodejs) | ||
- [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler) | ||
- [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag) | ||
- [Usage](#usage) | ||
- [Examples](#examples) | ||
- [Create a file composed by several blocks](#create-a-file-composed-by-several-blocks) | ||
- [Create a directory that contains several files](#create-a-directory-that-contains-several-files) | ||
- [API](#api) | ||
- [UnixFS Data Structure](#unixfs-data-structure) | ||
- [create an unixfs Data element](#create-an-unixfs-data-element) | ||
- [add and remove a block size to the block size list](#add-and-remove-a-block-size-to-the-block-size-list) | ||
- [get total fileSize](#get-total-filesize) | ||
- [marshal and unmarshal](#marshal-and-unmarshal) | ||
- [is this UnixFS entry a directory?](#is-this-unixfs-entry-a-directory) | ||
- [has an mtime been set?](#has-an-mtime-been-set) | ||
- [Contribute](#contribute) | ||
- [License](#license) | ||
|
||
## Structure | ||
|
||
* `/packages/ipfs-unixfs` Serialization/deserialization of UnixFS objects to protocol buffers | ||
* `/packages/ipfs-unixfs-importer` Builds DAGs from files and directories | ||
* `/packages/ipfs-unixfs-exporter` Exports DAGs | ||
|
||
## Contribute | ||
|
||
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs/issues)! | ||
|
||
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). | ||
|
||
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) | ||
|
||
## License | ||
|
||
[MIT](LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"lerna": "3.20.2", | ||
"packages": [ | ||
"packages/*" | ||
], | ||
"version": "independent", | ||
"command": { | ||
"bootstrap": { | ||
"hoist": true | ||
}, | ||
"run": { | ||
"stream": true | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"name": "js-ipfs-unixfs", | ||
"version": "1.0.0", | ||
"description": "JS implementation of the IPFS UnixFS", | ||
"scripts": { | ||
"postinstall": "lerna bootstrap", | ||
"reset": "lerna run --parallel clean && rm -rf packages/*/node_modules packages/*/package-lock.json node_modules", | ||
"test": "lerna run --parallel test", | ||
"test:node": "lerna run --parallel test:node", | ||
"test:browser": "lerna run --parallel test:browser", | ||
"test:webworker": "lerna run --parallel test:webworker", | ||
"coverage": "lerna run --parallel coverage", | ||
"build": "lerna run --parallel build", | ||
"deploy": "lerna run --parallel deploy", | ||
"start": "NODE_ENV=development lerna run --parallel start", | ||
"clean": "lerna run --parallel clean", | ||
"lint": "lerna run --parallel lint", | ||
"depcheck": "lerna run --parallel depcheck", | ||
"publish": "lerna publish" | ||
}, | ||
"devDependencies": { | ||
"lerna": "^3.20.2" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters