Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RadoBuransky committed Oct 25, 2014
1 parent f67e843 commit 9553797
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
--------------
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
- **Case classes with up to 22 fields** - Scala limits tuple size to 22
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down

0 comments on commit 9553797

Please sign in to comment.