X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=README.md;h=3b594b3716c105fea8749894ff5231f83a238e1a;hb=refs%2Fheads%2Fv1.x;hp=1f6222974078be66e0779984c5945c62d43c2577;hpb=8490761995fda3a9a8c43d6200dde2952e59b877;p=m6w6%2Flibmemcached

diff --git a/README.md b/README.md
index 1f622297..3b594b37 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
 # libmemcached
 
-[![Build Status](https://travis-ci.org/m6w6/libmemcached.svg?branch=v1.0)](https://travis-ci.org/m6w6/libmemcached) [![Join the chat at https://gitter.im/m6w6/libmemcached](https://badges.gitter.im/m6w6/libmemcached.svg)](https://gitter.im/m6w6/libmemcached?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Gitter Badge]](https://gitter.im/m6w6/libmemcached)
+[![License Badge]](https://opensource.org/licenses/BSD-3-Clause)
+
+[Gitter Badge]:     https://badges.gitter.im/m6w6/libmemcached.svg "Gitter Chat"
+[License Badge]:    https://img.shields.io/badge/License-BSD%203--Clause-blue.svg "BSD 3-Clause"
 
 libmemcached is an open source C/C++ client library and tools for the
 memcached server (http://memcached.org/). It has been designed to be
@@ -14,24 +18,63 @@ side methods.
 
 ## Documentation
 
+[![Docs Actions Badge]](
+    https://github.com/m6w6/libmemcached/actions?query=workflow%3Adocs-publish-pages)
+
+[Docs Actions Badge]:
+    https://github.com/m6w6/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x
+    "Github Docs Action"
+
 See https://m6w6.github.io/libmemcached
 
+### Building and updating docs
+
+See [gh-pages/publish](./docs/gh-pages/publish.sh) script and the
+[docs-publish-pages](./.github/workflows/docs-publish-pages.yml) workflow,
+which automate pushing updated documentation to github pages.
+
 ## Installing
 
-libmemcached uses `CMake`. Please see/edit `CMakeConfig.txt` or use
-`ccmake(1)` to set any preferred options.
+libmemcached uses `CMake`.
+Please see/edit [`CMakeConfig.txt`](./CMakeConfig.txt) or use `ccmake(1)` or
+`cmake-gui(1)` to set any preferred options.
 
 ### From source
 
-	git clone github.com:m6w6/libmemcached
-	mkdir build-libmemcached
-	cd $_
-	cmake ../libmemcached
-	make
-	sudo make install
+    git clone github.com:m6w6/libmemcached
+    mkdir build-libmemcached
+    cd $_
+    cmake ../libmemcached
+    make
+    sudo make install
+
+#### Requirements
+
+* CMake 3.9+
+* C++11 compiler
+* GNU Bison 2.3+ and Flex
+
+##### Optional dependencies
+
+* C++17 compiler (required for: tests)
+* Intel's libtbb (optional for: tests; for GCC's stdlib parallelism support)
+* pthreads (required for: tests, contrib/bin/memaslap, libmemcachedutil/pool)
+* libevent (required for: contrib/bin/memaslap)
+* Cyrus' libsasl2 (required for: libmemcached/sasl)
+
+### Binaries
+
+CI and release builds for Linux, a couple BSDs, MacOS and Windows are available at
+https://artifacts.m6w6.name/libmemcached/ and rsync://m6w6.name::artifacts/libmemcached/.
 
 ## Testing
 
+[![Codecov Badge]](https://codecov.io/gh/m6w6/libmemcached)
+
+[Codecov Badge]:
+    https://codecov.io/gh/m6w6/libmemcached/branch/v1.x/graph/badge.svg
+    "Code coverage"
+
 Enable the `BUILD_TESTING` setting for a build and run `make test`.
 
     cmake -DBUILD_TESTING=ON ../libmemcached
@@ -39,12 +82,33 @@ Enable the `BUILD_TESTING` setting for a build and run `make test`.
 
 ### Continuous integration
 
-CI/Test results are available at [Travis CI](https://travis-ci.org/m6w6/libmemcached).
- 
+[![Actions Badge]](https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci)
+[![Sourcehut Badge]](https://builds.sr.ht/~m6w6/libmemcached)
+
+[Actions Badge]:
+    https://github.com/m6w6/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x
+    "Github Actions"
+[Sourcehut Badge]:
+    https://builds.sr.ht/~m6w6/libmemcached/commits.svg
+    "Sourcehut Builds"
+
+CI/Testing is performed on the following system matrix:
+
+| OS               | Compiler                     | Arch                    | Comments                   |
+|------------------|------------------------------|-------------------------|----------------------------|
+| Linux            | GNU 7/9/10, Clang 9/10/11/12 | amd64                   | sasl, coverage, sanitizers |
+| MacOS            | AppleClang 12                | amd64                   | sasl, coverage             |
+| FreeBSD          | Clang 11                     | amd64                   | sasl, coverage             |
+| OpenBSD          | Clang 10                     | amd64                   | sasl, coverage             |
+| Windows          | MSVC 16, MinGW               | amd64                   | no sasl, no tests          |
+| Solaris          | SunPro 12.5                  | amd64                   | no sasl, no tests, manually|
+
+libmemcached has been tested against [memcached](https://github.com/memcached/memcached) v1.5 and v1.6.
+
 ## ChangeLog
 
-Check out the latest [releases](./releases) or the bundled
-[ChangeLog](./ChangeLog) for a comprehensive list of changes.
+Check out the latest [releases](https://github.com/m6w6/libmemcached/releases)
+or the bundled [ChangeLog](./ChangeLog-1.1.md) for a comprehensive list of changes.
 
 ## License
 
@@ -53,15 +117,12 @@ found in the accompanying [LICENSE](./LICENSE) file.
 
 ## Contributing
 
-All forms of contribution are welcome! Please see the bundled
-[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
-
-The list of past and current contributors is maintained in [THANKS](./THANKS).
+Please report any issues on the [bug tracker](https://github.com/m6w6/libmemcached/issues).
 
-The list of current maintainers is available in [AUTHORS](./AUTHORS).
+A list of known permanent issues is maintained in [BUGS](./BUGS.md).
 
-### Building and updating docs
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
 
-See [gh-pages/publish](./docs/gh-pages/publish.sh) script, which automates 
-pushing updated documentation to github pages.
+The list of current and past maintainers and contributors is available in [AUTHORS](./AUTHORS).