From 211c5006fd12d1e2d9ee05d3d6d1e6bae1fd4af5 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Sat, 26 Apr 2025 06:12:25 +0100 Subject: [PATCH] Update README.md to enhance description and clarity of Rustframe features --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 241a8d8..f31cb9c 100644 --- a/README.md +++ b/README.md @@ -8,24 +8,24 @@ --- -## Rustframe: *A lightweight dataframe helper for Rust* +## Rustframe: *A lightweight dataframe & math toolkit for Rust* -Rustframe is a simple dataframe helper for simple math and data manipulation in Rust. +Rustframe provides intuitive dataframe, matrix, and series operations small-to-mid scale data analysis and manipulation. Rustframe keeps things simple, safe, and readable. It is handy for quick numeric experiments and small analytical tasks, but it is **not** meant to compete with powerhouse crates like `polars` or `ndarray`. ### What it offers -- **Math that reads like math** – element‑wise `+`, `−`, `×`, `÷` on entire frames or scalars. -- **Broadcast & reduce** – sum, product, any/all across rows or columns without boilerplate. -- **Boolean masks made simple** – chain comparisons, combine with `&`/`|`, get a tidy `BoolMatrix` back. -- **Date‑centric row index** – business‑day ranges and calendar slicing built in. -- **Pure safe Rust** – 100 % safe, zero `unsafe`. +- **Math that reads like math** - element‑wise `+`, `−`, `×`, `÷` on entire frames or scalars. +- **Broadcast & reduce** - sum, product, any/all across rows or columns without boilerplate. +- **Boolean masks made simple** - chain comparisons, combine with `&`/`|`, get a tidy `BoolMatrix` back. +- **Date‑centric row index** - business‑day ranges and calendar slicing built in. +- **Pure safe Rust** - 100 % safe, zero `unsafe`. ### Heads up -- **Not memory‑efficient (yet)** – footprint needs work. -- **Feature set still small** – expect missing pieces. +- **Not memory‑efficient (yet)** - footprint needs work. +- **Feature set still small** - expect missing pieces. ### On the horizon