diff --git a/README.md b/README.md index b22a89a..1231b7e 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,28 @@ The lists support the following operations: * add/remove elements via single and bulk operations * replace elements * sort and shuffle ->* the lists know whether or not they are sorted and can leverage that knowledge for searching (binary search), union and intersection +* the lists know whether or not they are sorted and can leverage that knowledge for searching (binary search), union and intersection * search for elements * union, intersection, retainIf, retainAll removeIf, removeAll -* clear and trim are separate methods, so that the list can be re-used without having to reallocate memory +* clear and trim are separate methods, so that the list can be re-used without having to re-allocate memory * stream support * the lists are serializable and cloneable -* the list are **not** thread-safe +* the lists are **not** thread-safe -#Examples +# How to use +The library is still considered beta. There no pre-build artifacts on Maven Central or JCenter, but you can download them from repo.lucares.org. + +```groovy +apply plugin: 'maven' +repositories { + maven { url 'https://repo.lucares.org/' } +} +dependencies { + compile 'org.lucares:primitiveCollections:0.1.20171228131833' +} +``` + +# Examples ```java import org.lucares.collections.IntList;