X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=4f977d0d8d9ee7d5b627ef5b37caad855e1f3224;hb=26f53452d85d209c5275da203c9947135a8ec667;hp=1f6222974078be66e0779984c5945c62d43c2577;hpb=8490761995fda3a9a8c43d6200dde2952e59b877;p=awesomized%2Flibmemcached diff --git a/README.md b/README.md index 1f622297..4f977d0d 100644 --- 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) [![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 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 | +| [Cirrus CI] | ![Cirrus CI Badge] | FreeBSD | 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,6 +67,10 @@ 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. @@ -62,6 +80,16 @@ The list of current maintainers is available in [AUTHORS](./AUTHORS). ### Building and updating docs -See [gh-pages/publish](./docs/gh-pages/publish.sh) script, which automates +See [gh-pages/publish](./docs/gh-pages/publish.sh) script, which automates pushing updated documentation to github pages. +[Travis CI]: https://travis-ci.org/github/m6w6/libmemcached "Travis CI Build Status" +[Travis CI Badge]: https://api.travis-ci.org/m6w6/libmemcached.svg?branch=v1.x "Travis CI Build Status" +[Cirrus CI]: https://cirrus-ci.com/github/m6w6/libmemcached "Cirrus CI Build Status" +[Cirrus CI Badge]: https://api.cirrus-ci.com/github/m6w6/libmemcached.svg?branch=v1.x "Cirrus CI Build Status" +[GH Actions]: https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci "GH Actions Build Status" +[GH Actions Badge]: https://img.shields.io/github/workflow/status/m6w6/libmemcached/cmake-build-ci?style=flat "GH Actions Build Status" + + +[Codecov]: https://codecov.io/gh/m6w6/libmemcached "Codecov Code Coverage" +[Codecov Badge]: https://codecov.io/gh/m6w6/libmemcached/branch/v1.x/graph/badge.svg "Codecov Code Coverage"