prepare v1.1.4
[awesomized/libmemcached] / README.md
index c82068459f50188d888c4f386602529328395157..1fb2c0cacf2b4e8338bc90db93a7bb437090e085 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,28 @@
-# libmemcached
+# libmemcached-awesome
 
-[![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
-light on memory usage, thread safe, and provide full access to server
-side methods.
+libmemcached-awesome is an open source C/C++ client library and tools
+for the memcached server (http://memcached.org/). It has been designed
+to be light on memory usage, thread safe, and provide full access to
+server side methods.
 
 > **NOTE:**  
 > This is a resurrection of the original work from Brian Aker at
-> [libmemcached.org](https://libmemcached.org) and the only publicly maintained
-> version of libmemcached currently known to me.
+> [libmemcached.org](https://libmemcached.org).
 
 ## Documentation
 
 [![Docs Actions Badge]](
-    https://github.com/m6w6/libmemcached/actions?query=workflow%3Adocs-publish-pages)
+    https://github.com/awesomized/libmemcached/actions?query=workflow%3Adocs-publish-pages)
 
 [Docs Actions Badge]:
-    https://github.com/m6w6/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x
+    https://github.com/awesomized/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x
     "Github Docs Action"
 
-See https://m6w6.github.io/libmemcached
+See https://awesomized.github.io/libmemcached
 
 ### Building and updating docs
 
@@ -35,13 +32,13 @@ which automate pushing updated documentation to github pages.
 
 ## Installing
 
-libmemcached uses `CMake`.
+libmemcached-awesome 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
+    git clone github.com:awesomized/libmemcached
     mkdir build-libmemcached
     cd $_
     cmake ../libmemcached
@@ -60,7 +57,7 @@ Please see/edit [`CMakeConfig.txt`](./CMakeConfig.txt) or use `ccmake(1)` or
 * 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: libmemacached/sasl)
+* Cyrus' libsasl2 (required for: libmemcached/sasl)
 
 ### Binaries
 
@@ -69,12 +66,6 @@ https://artifacts.m6w6.name/libmemcached/ and rsync://m6w6.name::artifacts/libme
 
 ## 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
@@ -82,11 +73,11 @@ Enable the `BUILD_TESTING` setting for a build and run `make test`.
 
 ### Continuous integration
 
-[![Actions Badge]](https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci)
+[![Actions Badge]](https://github.com/awesomized/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
+    https://github.com/awesomized/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x
     "Github Actions"
 [Sourcehut Badge]:
     https://builds.sr.ht/~m6w6/libmemcached/commits.svg
@@ -96,27 +87,30 @@ CI/Testing is performed on the following system matrix:
 
 | OS               | Compiler                     | Arch                    | Comments                   |
 |------------------|------------------------------|-------------------------|----------------------------|
-| Linux            | GNU 7/9/10, Clang 9/10/11    | amd64                   | sasl, coverage, sanitizers |
+| Linux            | GNU 7/9/10, Clang 9/10/11/12 | amd64                   | sasl, coverage, sanitizers |
 | MacOS            | AppleClang 12                | amd64                   | sasl, coverage             |
-| FreeBSD, OpenBSD | Clang 10                     | 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.
+libmemcached-awesome has been tested against [memcached](https://github.
+com/memcached/memcached) v1.5 and v1.6.
 
 ## ChangeLog
 
-Check out the latest [releases](https://github.com/m6w6/libmemcached/releases)
+Check out the latest [releases](https://github.com/awesomized/libmemcached/releases)
 or the bundled [ChangeLog](./ChangeLog-1.1.md) for a comprehensive list of changes.
 
 ## License
 
-libmemcached is licensed under the 3-Clause-BSD license, which can be
+libmemcached-awesome is licensed under the 3-Clause-BSD license, which 
+can be
 found in the accompanying [LICENSE](./LICENSE) file.
 
 ## Contributing
 
-Please report any issues on the [bug tracker](https://github.com/m6w6/libmemcached/issues).
+Please report any issues on the [bug tracker](https://github.com/awesomized/libmemcached/issues).
 
 A list of known permanent issues is maintained in [BUGS](./BUGS.md).