docs: add changelogs [ci skip]
[awesomized/libmemcached] / docs / source / libhashkit / index.rst
index 3915fd9f3070d8fe61cc618712ffa80f43dec2df..1624655962410adf999a79f74c2103c7faf46079 100644 (file)
@@ -1,5 +1,19 @@
-libhashkit API
-==============
+libhashkit - C/C++ hashing library
+==================================
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit.
+
+DESCRIPTION
+-----------
+
+`libhashkit` is a small and thread-safe client library that provides a collection
+of useful hashing algorithms.
+
+`libhashkit` is distributed with `libmemcached`.
 
 .. toctree::
     :titlesonly:
@@ -9,3 +23,18 @@ libhashkit API
     hashkit_function
     hashkit_functions
     hashkit_value
+
+SEE ALSO
+--------
+
+.. only:: man
+
+    :manpage:`libmemcached(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+    :manpage:`hashkit_functions(3)`
+    :manpage:`hashkit_value(3)`
+
+.. only:: html
+
+    * :doc:`../libmemcached`