Skip to content

Commit

Permalink
package fix
Browse files Browse the repository at this point in the history
  • Loading branch information
sanity committed Mar 15, 2017
1 parent 3d23450 commit 6e13446
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,24 @@

[![Build Status](https://travis-ci.org/sanity/shoebox.svg?branch=master)](https://travis-ci.org/sanity/shoebox)

##
ShoeBox is a [Kotlin](http://kotlinlang.org/) library for object persistence that supports change observers.

ShoeBox was created as a simple persistence layer for [Kweb](http://kweb.io/) applications, motivated primarily by
the lack of simple peristence mechanisms that support observation.

### Features
* Semantics similar to MutableMap
* Add listeners for object addition, deletion, and modification
* Fairly comprehensive unit tests
* Add views, which can index objects by any computed value, and which will stay in sync automatically
* Views also support change modifications

### Limitations
* Doesn't implement the MutableMap interface
* This is because some MutableMap operations would require loading the entire Map into RAM
* Uses the filesystem for persistent storage, although alternate back-ends can be supported in future

### Usage Example

### Documentation
*
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
group 'com.github.sanity'
version '0.1.1'
version '0.1.2'

buildscript {
ext.kotlin_version = '1.1.0'
Expand Down
2 changes: 1 addition & 1 deletion src/main/kotlin/com/github/sanity/shoebox/utils.kt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package propheto
package com.github.sanity.shoebox

import java.nio.file.Files
import java.nio.file.OpenOption
Expand Down

0 comments on commit 6e13446

Please sign in to comment.