Project version

CMakeLists.txt

@@ -4,7 +4,16 @@ if(NOT CMAKE_CXX_STANDARD)
     set(CMAKE_CXX_STANDARD 20)
 endif()
 
-project(libhat)
+set(LIBHAT_VERSION_MAJOR 0)
+set(LIBHAT_VERSION_MINOR 1)
+set(LIBHAT_VERSION_PATCH 0)
+set(LIBHAT_VERSION ${LIBHAT_VERSION_MAJOR}.${LIBHAT_VERSION_MINOR}.${LIBHAT_VERSION_PATCH})
+
+project(libhat
+    VERSION ${LIBHAT_VERSION}
+    DESCRIPTION "A high-performance, modern, C++20 library designed around game hacking"
+    HOMEPAGE_URL "https://github.com/BasedInc/libhat"
+)
 
 option(LIBHAT_STATIC_C_LIB "Build a static version of the C library" OFF)
 option(LIBHAT_SHARED_C_LIB "Build a shared version of the C library" OFF)

README.md

@@ -8,6 +8,11 @@ A modern, high-performance library for C++20 designed around game hacking
 - Convenience wrappers over OS APIs
 - Language bindings (C, C#, etc.)
 
+## Versioning
+This project adheres to [semantic versioning](https://semver.org/spec/v2.0.0.html). Any declaration that
+is within a `detail` or `experimental` namespace is not considered part of the public API, and usage
+may break at any time without the MAJOR version number being incremented.
+
 ## Benchmarks
 The table below compares the single threaded throughput in bytes/s (real time) between
 libhat and [two other](test/benchmark/vendor) commonly used implementations for pattern