From e3818f3d7b9624936dd42540c38d0c3512ecf088 Mon Sep 17 00:00:00 2001
From: cyanlemons <64322512+cyanlemons@users.noreply.github.com>
Date: Sat, 3 Oct 2020 17:08:38 +0000
Subject: [PATCH] Add CONFIG_ENFORCE_INIT to the README

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 859bdda..81fcd90 100644
--- a/README.md
+++ b/README.md
@@ -266,6 +266,11 @@ The following boolean configuration options are available:
   the future. Whether or not this feature is enabled, the metadata is all
   contained within an isolated memory region with high entropy random guard
   regions around it.
+* `CONFIG_ENFORCE_INIT`: `true` (default) or `false` to control whether the
+  allocator initialization should be enforced. The primary purpose of this
+  check is to detect any attempts to free memory before there have been any
+  allocations. This check should rarely fail as this implementation will
+  attempt to initialize the allocator very early on.
 
 The following integer configuration options are available: