[libgee] Update README



commit 5f2028e4a289edbfe376b836c797a73e0ace3294
Author: Maciej Piechotka <uzytkownik2 gmail com>
Date:   Mon Sep 24 22:05:00 2012 +0200

    Update README

 README       |   46 ++++++++++++++++++++++++++++++++--------------
 configure.ac |    2 +-
 2 files changed, 33 insertions(+), 15 deletions(-)
---
diff --git a/README b/README
index 9236473..69be7cb 100644
--- a/README
+++ b/README
@@ -1,20 +1,38 @@
-libgee is a collection library providing GObject-based interfaces and
+Libgee is a collection library providing GObject-based interfaces and 
 classes for commonly used data structures.
 
-libgee provides the following interfaces:
+Libgee provides the following interfaces:
 
-	* Iterable
-	  * Collection
-	    * List
-	    * Set
-	* Iterator
-	* Map
+     * Traversable
+           o Iterable
+                 + Collection
+                       # List
+                             * BidirList
+                       # Set
+                             * SortedSet
+                                 o BidirSortedSet
+                       # MultiSet
+                       # Queue
+                             * Deque
+                 + Map
+                       # SortedMap
+                             * BidirSortedMap
+           o Iterator
+                 + BidirIterator
+                       # BidirListIterator
+                 + ListIterator
+                       # BidirListIterator
+     * MultiMap
 
-The ArrayList, HashSet, and HashMap classes provide a reasonable sample
-implementation of the List, Set, and Map interfaces. ReadOnlyCollection,
-ReadOnlyList, ReadOnlySet, and ReadOnlyMap are read-only wrapper classes
-that prevent modification of the underlying collection.
+The ArrayList, ArrauQueue, ConcurrentLinkedList HashSet, HashMap, HashMultiSet,
+HashMultiMap, LinkedList, PriorityQueue, TreeSet, TreeMap,
+TreeMultiSet, and TreeMultiMap classes provide a reasonable sample
+implementation of those interfaces. In addition, a set of abstract
+classes are provided to ease the implementation of new collections.
 
-libgee is written in Vala and can be used like any GObject-based C library.
-It's planned to provide bindings for further languages.
+Around that, the API provide means to retrieve read-only views, 
+efficient sort algorithms, simple, bi-directional or index-based mutable 
+iterators depending on the collection type.
 
+Libgee is written in Vala and can be used like any GObject-based C 
+library. It's planned to provide bindings for further languages.
diff --git a/configure.ac b/configure.ac
index 68e201c..8040101 100644
--- a/configure.ac
+++ b/configure.ac
@@ -11,7 +11,7 @@ AM_PROG_CC_C_O
 AC_DISABLE_STATIC
 AC_PROG_LIBTOOL
 
-LIBGEE_LT_VERSION="1:0:0"
+LIBGEE_LT_VERSION="2:0:0"
 AC_SUBST(LIBGEE_LT_VERSION)
 
 AM_PROG_VALAC([0.17.5])



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]