Skip to content
This repository has been archived by the owner on Jul 14, 2019. It is now read-only.

Commit

Permalink
fix(docs): Add documentation for both implementations.
Browse files Browse the repository at this point in the history
New docs for implementation. This release is tagged as a fix so that npm gets the new README.
  • Loading branch information
mikeal committed Jul 17, 2017
1 parent 36da9ed commit 10e2c1e
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,26 @@ class Store {

## In-Memory Implementation

## Filesystem Implementation
```javascript
let store = require('lucass/inmemory')()
store.set(Buffer.from('asdf'), (err, hash) => {
store.getBuffer(hash, (err, value) => {
console.log(value.toString) // 'asdf'
})
})
```

Additionally, all methods in the spec are implemented.

## Filesystem Implementation

```javascript
let store = require('lucass/fs')('/var/custom-directory')
store.set(Buffer.from('asdf'), (err, hash) => {
store.getBuffer(hash, (err, value) => {
console.log(value.toString) // 'asdf'
})
})
```

Additionally, all methods in the spec are implemented.

0 comments on commit 10e2c1e

Please sign in to comment.