From 6e1344617d24e603553fcd708d9d250b5c7c3516 Mon Sep 17 00:00:00 2001 From: Ian Clarke Date: Tue, 14 Mar 2017 21:26:31 -0500 Subject: [PATCH] package fix --- README.md | 22 ++++++++++++++++++- build.gradle | 2 +- .../kotlin/com/github/sanity/shoebox/utils.kt | 2 +- 3 files changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a4be051..7d51e62 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,24 @@ [![Build Status](https://travis-ci.org/sanity/shoebox.svg?branch=master)](https://travis-ci.org/sanity/shoebox) -## \ No newline at end of file +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 +* \ No newline at end of file diff --git a/build.gradle b/build.gradle index 83718a6..02af264 100644 --- a/build.gradle +++ b/build.gradle @@ -1,5 +1,5 @@ group 'com.github.sanity' -version '0.1.1' +version '0.1.2' buildscript { ext.kotlin_version = '1.1.0' diff --git a/src/main/kotlin/com/github/sanity/shoebox/utils.kt b/src/main/kotlin/com/github/sanity/shoebox/utils.kt index 7ffd062..482c0f0 100644 --- a/src/main/kotlin/com/github/sanity/shoebox/utils.kt +++ b/src/main/kotlin/com/github/sanity/shoebox/utils.kt @@ -1,4 +1,4 @@ -package propheto +package com.github.sanity.shoebox import java.nio.file.Files import java.nio.file.OpenOption