Skip to content

Commit 8dc3752

Browse files
committed
docs: update project description and readme.md
1 parent 8f50c42 commit 8dc3752

2 files changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,25 @@ _Simplifying Math, Empowering Code._
88

99
</div>
1010

11-
>Note: This repository has been transfered from [henryhale](https://github.com/henryhale)/mathflow
12-
>to [mathflowjs](https://github.com/mathflowjs). Check out the [TODO.md](https://github.com/mathflowjs/mathflow/blob/master/TODO.md) file to view the roadmap of this project.
13-
1411
## Overview
1512

16-
MathFlow is a lightweight and expressive scripting language designed for mathematical expressions and calculations. It provides a simple and intuitive syntax for performing mathematical operations, including support for standard arithmetic, functions like sin, cos, tan, and other functions.
13+
MathFlow is a lightweight JavaScript library for evaluating mathematical expressions written in natural mathematical notation. It parses and computes standard arithmetic, trignometric functions, logarithms, and algebraic expressions exactly as you would write them on paper.
1714

1815
## Features
1916

20-
- **Mathematical Expressions:** Perform standard arithmetic operations with ease.
21-
- **Functions:** Built-in support for mathematical functions such as sin, cos, tan, abs and more.
22-
- **Clean and Modern Syntax:** Readable and easy-to-write syntax for mathematical expressions.
23-
- **Abstract Syntax Tree (AST):** Utilizes an AST for parsing and interpreting expressions.
17+
- **Natural syntax:** Write `2x + 3(y - 1)` instead of `2*x + 3*(y - 1)`. Both are supported anyway.
18+
- **Mathematical functions:** Built-in support for `sin`, `cos`, `tan`, `log`, `sqrt`, `abs`, and more.
19+
- **Variables:** Assign and use variables like `x = 5`, `y = 5x - 1`
20+
- **Clean & modern syntax:** Readable and easy-to-write syntax for mathematical expressions.
21+
- **AST-based parsing:** Proper order of operations and expression evaluation.
22+
- **Lightweight:** Focused purely on mathematical computation without bloat.
23+
24+
## Use Cases
25+
26+
- Formula calculators and mathematical tools.
27+
- Educational applications for learning mathematics.
28+
- Basic scientific computing interfaces.
29+
- Anywhere you need to evaluate user-input mathematical expressions safely.
2430

2531
## Documentation
2632

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "mathflow",
33
"version": "0.3.0",
4-
"description": "A concise, expressive scripting language for mathematical calculations with standard functions.",
4+
"description": "A lightweight library for evaluating mathematical expressions written in natural mathematical notation.",
55
"type": "module",
66
"exports": {
77
".": {

0 commit comments

Comments
 (0)