doc: Roadmap on the main page and hash func info

GreenmaskIO · May 17, 2024 · 87d5455 · 87d5455
1 parent b0aa2b4
commit 87d5455
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/built_in_transformers/transformation_engines.md b/docs/built_in_transformers/transformation_engines.md
@@ -4,6 +4,13 @@ The greenmask provides two engines `random` and `hash`. Most of the transformers
 by default is set to `random`. Use `hash` engine when you need to generate deterministic data - the same input
 will always produce the same output.
 
+!!! info
+
+    Greenmask employs the `SHA-3` algorithm to hash input values. While this function is cryptographically secure, it does
+    exhibit lower performance. We plan to introduce additional hash functions in the future to offer a balance between
+    security and performance. For example, `SipHash`, which provides a good trade-off between security and performance, is
+    currently in development and is expected to be included in the stable `v0.2` release of Greenmask.
+
 !!! warning
 
     The hash engine does not guarantee the uniqueness of generated values. Although transformers such as `Hash`, 

diff --git a/docs/index.md b/docs/index.md
@@ -59,6 +59,7 @@ Greenmask is ideal for various scenarios, including:
 
 ## Links
 
+* [Greenmask Roadmap](https://github.com/orgs/GreenmaskIO/projects/6)
 * [Email](mailto:[email protected])
 * [Twitter](https://twitter.com/GreenmaskIO)
 * [Telegram](https://t.me/greenmask_community)