README

[awesomized/libmemcached] / README.md

diff --git a/README.md b/README.md
index 75bf2a943bbb4291285b418a062b1173dfbe06a2..1149766ce24f3c18391d2579a4806301314afe76 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # libmemcached
 
-[![Build Status](https://travis-ci.org/m6w6/libmemcached.svg?branch=v1.0)](https://travis-ci.org/m6w6/libmemcached)
+[![Gitter Chat](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)
+[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/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
@@ -23,12 +24,12 @@ libmemcached uses `CMake`. Please see/edit `CMakeConfig.txt` or use
 
 ### 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
 
 ## Testing
 
@@ -39,12 +40,25 @@ 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).
- 
+CI/Test results are available at:
+
+| Provider       | Status                | OS               | Compiler   | Arch                  |
+|----------------|-----------------------|------------------|------------|-----------------------|
+| [Travis CI]    | ![Travis CI Badge]    | Linux            | GNU        | arm64, ppc64le, s390x |
+| [Builds.sr.ht] | ![Builds.sr.ht Badge] | FreeBSD, OpenBSD | Clang      | amd64                 |
+| [GH Actions]   | ![GH Actions Badge]   | Linux, MacOS     | GNU, Clang | amd64                 |
+
+Additional project metrics:
+
+| Provider  | Type          | Status           |
+|-----------|---------------|------------------|
+| [Codecov] | Code coverage | ![Codecov Badge] |
+
+
 ## 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.md) for a comprehensive list of changes.
 
 ## License
 
@@ -53,15 +67,29 @@ found in the accompanying [LICENSE](./LICENSE) file.
 
 ## Contributing
 
+Please report any issues on the [bug tracker](https://github.com/m6w6/libmemcached/issues).
+
+A list of known permanent issues is maintained in [BUGS](./BUGS.md).
+
 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).
-
-The list of current maintainers is available in [AUTHORS](./AUTHORS).
+The list of current and past maintainers and contributors is available in [AUTHORS](./AUTHORS).
 
 ### Building and updating docs
 
-See [gh-pages/publish](./docs/gh-pages/publish.sh) script, which automates 
-pushing updated documentation to github pages.
-
+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.
+
+[Travis CI]:            https://travis-ci.org/github/m6w6/libmemcached
+[Travis CI Badge]:      https://api.travis-ci.org/m6w6/libmemcached.svg?branch=v1.x
+[Cirrus CI]:            https://cirrus-ci.com/github/m6w6/libmemcached
+[Cirrus CI Badge]:      https://api.cirrus-ci.com/github/m6w6/libmemcached.svg?branch=v1.x
+[GH Actions]:           https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci
+[GH Actions Badge]:     https://github.com/m6w6/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x
+[Builds.sr.ht]:         https://builds.sr.ht/~m6w6/libmemcached
+[Builds.sr.ht Badge]:   https://builds.sr.ht/~m6w6/libmemcached/commits.svg
+
+[Codecov]:          https://codecov.io/gh/m6w6/libmemcached
+[Codecov Badge]:    https://codecov.io/gh/m6w6/libmemcached/branch/v1.x/graph/badge.svg