From f1f632854cff70a95b9de11a44832d19095123a8 Mon Sep 17 00:00:00 2001 From: Avril Date: Thu, 3 Dec 2020 19:43:29 +0000 Subject: [PATCH] update README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index fdb652f..d293073 100644 --- a/README.md +++ b/README.md @@ -65,10 +65,21 @@ Also provided are `memfrob()` and `strfrob()` functions of our own for both stri constexpr const auto ctime = frob::strfrob<>("done at comptime, like the literal `_frob`"); // Explicit template `<>` is required here otherwise it overloads to the non `constexpr` functions, even in a `constexpr` context; } +``` + +All functions (except the literal operator) are in the namespace `frob`. +## Configuring +By default we use the same mechanism as `memfrob()`: ROT13 via bitwise xor of the number 42. +If you would like to use a different number for the bitwise xor, defined the constant `FROB_CONSTANT` before `#include`ing the header. +``` c++ +#define FROB_CONSTANT 82 +#include "cfrob.hpp" ``` +Note that the defined constant must fit in the range `0-255` inclusive. + # Test Run `make test` to build and run the test that ensures the original string literal does not appear anywhere in the outputted binary.