From a1db00388fc496957a33de9ae6af72346e613d1e Mon Sep 17 00:00:00 2001
From: Parham Alvani <perhama@kaytu.io>
Date: Wed, 27 Dec 2023 05:59:39 +0000
Subject: [PATCH] feat: add fp into the readme

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

diff --git a/README.md b/README.md
index d8450a3..ed202e7 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,15 @@
 Share utilities between Kaytu go projects and microservices. These modules are provided
 under the `/pkg` and as follows:
 
+### `/pkg/fp`
+
+This package contains functional programming style of things, for example when you want to accept optional
+string parameter you can define it as `*string` and then using the `fp` package pass the value into it:
+
+```go
+fp.Optional("I am an optional string")
+```
+
 ### `/pkg/koanf`
 
 Load configuration from environment variables, file and default based on [koanf](https://github.com/knadh/koanf).