https://github.com/zkat/cadr

content-addressable filesystem snapshots
https://github.com/zkat/cadr

cache filesystem

Last synced: 8 months ago
JSON representation

content-addressable filesystem snapshots

• Host: GitHub
• URL: https://github.com/zkat/cadr
• Owner: zkat
• License: other
• Created: 2017-06-03T22:24:39.000Z (over 8 years ago)
• Default Branch: latest
• Last Pushed: 2018-07-12T02:49:33.000Z (over 7 years ago)
• Last Synced: 2025-05-07T15:09:14.366Z (8 months ago)
• Topics: cache, filesystem
• Language: JavaScript
• Size: 117 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# cadr [![npm version](https://img.shields.io/npm/v/cadr.svg)](https://npm.im/cadr) [![license](https://img.shields.io/npm/l/cadr.svg)](https://npm.im/cadr) [![Travis](https://img.shields.io/travis/zkat/cadr.svg)](https://travis-ci.org/zkat/cadr) [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/zkat/cadr?svg=true)](https://ci.appveyor.com/project/zkat/cadr) [![Coverage Status](https://coveralls.io/repos/github/zkat/cadr/badge.svg?branch=latest)](https://coveralls.io/github/zkat/cadr?branch=latest)

[`cadr`](https://github.com/zkat/cadr) is a Node.js library for caching

snapshots of filesystem trees. It supports full data verification on input and

output, and is pretty fast at handling a bunch of files at a time.

## Install

`$ npm install --save cadr`

## Table of Contents

* [Example](#example)

* [Features](#features)

* [Contributing](#contributing)

* [API](#api)

### Example

```javascript

```

### Features

* Fast

* Corruption-safe and fault-tolerant

* Pure JavaScript

* Content-addressable

* Disk-efficient

### Contributing

The cadr team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! The [Contributor Guide](CONTRIBUTING.md) has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

All participants and maintainers in this project are expected to follow [Code of Conduct](CODE_OF_CONDUCT.md), and just generally be excellent to each other.

Please refer to the [Changelog](CHANGELOG.md) for project history details, too.

Happy hacking!

### API

#### Pronunciation

`cadr` is pronounced [`['ka,duhr]`](http://www.lispworks.com/documentation/HyperSpec/Body/f_car_c.htm) or `['kei,duhr']`. Never like "cadre".