Skip to content

Commit 6aa7c09

Browse files
author
Matt Zumwalt
committed
initial README and package.json
fixes #4
0 parents  commit 6aa7c09

File tree

4 files changed

+72
-0
lines changed

4 files changed

+72
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
tmp
2+
node_modules

LICENSE

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Copyright (c) 2016 Matt Zumwalt. All rights reserved.
2+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
3+
4+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
5+
6+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
7+
8+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
9+
10+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# dat jawn: 'Git for Tabular Data'
2+
3+
Jawn is a node.js module that allows _distributed version control of Tabular Data_. It's connected to the [dat](https://github.com/maxogden/dat) project.
4+
5+
Jawn allows you to import tabular data (rows and columns like CSV or TSV) and track how those data change over time. It uses [hypercore](https://github.com/mafintosh/hypercore) to put those data into block chains that can be efficiently synced and validated across any number of hosts.
6+
7+
The key features for jawn are to:
8+
* **manage and track change history** in tabular data
9+
* **create historical checkpoints** with metadata (e.g., message, timestamp, author)
10+
11+
Jawn relies on [hypercore](https://github.com/mafintosh/hypercore) to handle the core functions around creating merkle chains, which allows us to
12+
13+
* **supply access points to data** across the network with a peer-to-peer model
14+
* **sync incrementally** between machines
15+
16+
This is where jawn connects with the current work of the dat team, who created hypercore and are using it to do the same things with directories of files. For more background info, read our [Technical Background and Reference Code Bases](https://github.com/CfABrigadePhiladelphia/jawn/wiki/Technical-Background-and-Reference-Code-Bases) wiki page.
17+
18+
## Project Team
19+
20+
jawn is maintained by a [Code for Philly](https://codeforphilly.org) project that aims to be a model for mentorship and collaborative learning. For full information about the project go to the [jawn project page](https://codeforphilly.org/projects/dat_tables)
21+
22+
We welcome contributions from anyone.
23+
24+
## Usage
25+
26+
_work in progress_
27+
28+
## Contributing
29+
30+
_work in progress_

package.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "jawn",
3+
"version": "0.0.1",
4+
"description": "Tabular Data support for Dat/hypercore",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "standard && tape test/*.js"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://github.com/CfABrigadePhiladelphia/jawn.git"
12+
},
13+
"keywords": [
14+
"data",
15+
"version control"
16+
],
17+
"author": "Matt Zumwalt",
18+
"license": "MIT",
19+
"bugs": {
20+
"url": "https://github.com/CfABrigadePhiladelphia/jawn/issues"
21+
},
22+
"homepage": "https://github.com/CfABrigadePhiladelphia/jawn",
23+
"dependencies": {
24+
"hypercore": "^1.6.2"
25+
},
26+
"devDependencies": {
27+
"standard": "^6.0.5",
28+
"tape": "^4.4.0"
29+
}
30+
}

0 commit comments

Comments
 (0)