From 9553797c9021f0abde3e2822ad8adfc9515e4a37 Mon Sep 17 00:00:00 2001 From: Rado Buransky Date: Sat, 25 Oct 2014 19:56:13 +0200 Subject: [PATCH] Readme --- README.md | 12 +++++++----- build.gradle | 2 +- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 60c258f..0dc8d2d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ [![Build Status](https://travis-ci.org/RadoBuransky/scala-struct.svg?branch=master)](https://travis-ci.org/RadoBuransky/scala-struct) -Scala Struct 0.1.0 +Scala Struct 1.0.0 ================== -Scala library for memory-optimized structures. Store fixed-size data structures in a byte buffer and retrieve them -later. +Scala library for memory-optimized structures. + +Easily store fixed-size data structures in a byte buffer and retrieve them later. Significantly reduces memory +requirements especially when large numbers of small structures have to be kept in memory. Simple example -------------- @@ -40,7 +42,7 @@ Simple example 6 times less memory example --------------------------- This example compares Java heap memory consumption of Scala Struct with standard mutable ArrayBuffer. The result is that -Scala Struct takes *6 times less space* in memory. +Scala Struct takes *6 times less space* in memory. 5 MB versus 29 MB. object SimpleMemoryComparisonExample { // Simple case class that we would like to store efficiently in the buffer, @@ -87,4 +89,4 @@ Supported features ------------------ - **Basic value types** - Byte, Short, Int, Long, Float, Double, Boolean - **Fixed buffer** - byte buffer which can store structres with fixed size -- **Strcutres with up to 22 fields** - Scala limits tuple size to 22 \ No newline at end of file +- **Case classes with up to 22 fields** - Scala limits tuple size to 22 \ No newline at end of file diff --git a/build.gradle b/build.gradle index 46e5ffb..aaf8386 100644 --- a/build.gradle +++ b/build.gradle @@ -14,7 +14,7 @@ apply plugin: org.scoverage.ScoveragePlugin targetCompatibility = 1.6 group = 'com.buransky' -version = '0.1.0' +version = '1.0.0' repositories { mavenCentral()