From 7881302e6c15005bd808c46aa229820b83c21223 Mon Sep 17 00:00:00 2001 From: Falko Habel Date: Fri, 14 Mar 2025 14:26:13 +0100 Subject: [PATCH] updated readme to give better explanation --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf79f62..5a624fd 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,21 @@ pip install git+https://gitea.fabelous.app/Fabel/fabelous-math.git To use the functions provided by Fabelous Math in your Python code, you can import them as follows: ```python -from fabelous_math import is_even, is_odd +from fabelous_math import is_even, is_odd, rooting, approximate_pi -# Example usage: number = 42 print(f"Is {number} even? {is_even(number)}") print(f"Is {number} odd? {is_odd(number)}") -``` +# Extended feature for rooting with a specified root +root = 4 +number = 16 +print(f"Rooting {number} to the power of {root}: {rooting(number, root)}") + +# Extended feature for approximate_pi with additional parameters if needed +precision = 10000000 +print(f"Approximate Pi with precision {precision}: {approximate_pi(precision)}") +``` ## Performance Comparison To understand the performance of `fabelous-math` functions, I conducted a series of tests comparing my methods with traditional modulo operations. Below are the results: