Merge branch 'dev'

[libcds.git] / readme.md

diff --git a/readme.md b/readme.md
index 98dca249584c37f4e9433ff9353a0a36934c0b4e..7bbc73847151806ac6e472230eef224bf94896c3 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,14 @@
 CDS C++ library\r
 ===============\r
+[![GitHub version](https://badge.fury.io/gh/khizmax%2Flibcds.svg)](http://badge.fury.io/gh/khizmax%2Flibcds)\r
+<!---\r
+The build time for lib and hdr-test is exceed the limit of 50 minutes\r
+[![Build Status](https://travis-ci.org/khizmax/libcds.svg?branch=dev)](https://travis-ci.org/khizmax/libcds)\r
+-->\r
+<!---\r
+The coverity dataset is about 4G of size and about 1G in compressed state so it is a problem to upload it to the coverity server\r
+[![Coverity Scan Build Status](https://scan.coverity.com/projects/4445/badge.svg)](https://scan.coverity.com/projects/4445)\r
+-->\r
 \r
 The Concurrent Data Structures (CDS) library is a collection of concurrent containers\r
 that don't require external (manual) synchronization for shared access, and safe memory reclamation (SMR) \r
@@ -9,9 +18,10 @@ CDS is mostly header-only template library. Only SMR core implementation is segr
 \r
 The library contains the implementations of the following containers:\r
   - [lock-free](http://en.wikipedia.org/wiki/Non-blocking_algorithm) stack with optional elimination support\r
-  - several algo for lock-free queue, including classic Michael & Scott algorithm and it's derivatives,\r
-    flat combining queue, segmented queue.\r
+  - several algo for lock-free queue, including classic Michael & Scott algorithm and its derivatives,\r
+    the flat combining queue, the segmented queue.\r
   - several implementation of unordered set/map - lock-free and fine-grained lock-based\r
+  - [flat-combining] (http://mcg.cs.tau.ac.il/projects/projects/flat-combining) technique\r
   - lock-free [skip-list](http://en.wikipedia.org/wiki/Skip_list)\r
   \r
 Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to \r
@@ -22,6 +32,14 @@ and MS VC++ 12 (2013) Update 4.
 \r
 Download the latest release from http://sourceforge.net/projects/libcds/files/\r
 \r
+See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html\r
+\r
+**Pull request requirements**\r
+- Pull-request to *master* branch will be unconditionally rejected\r
+- *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master*\r
+- *dev* branch is intended for main developing. Usually, it contains unstable code\r
+\r
+\r
 References\r
 ----------\r
 *Stack*\r