Skip to content

Commit 34f5e4a

Browse files
omidgithub-actions[bot]
authored andcommitted
Update README.md
1 parent c2830d6 commit 34f5e4a

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@
77
A parser and evaluator of spreadsheet-like formulas
88
</h3>
99

10-
It's in its early stages, and we are trying to add more functions and features soon.
10+
Formula is in its early stages and is not ready for production use.
1111

1212
So far we have the following features:
1313

1414
- 18 date time functions
1515
- 26 text functions
16+
- 7 logical functions
17+
- 2 web functions
18+
- plus all arithmetic and comparison operators
1619

1720
### Installation and usage
1821

@@ -25,18 +28,19 @@ use formula::{Formula, Expr, error::Error};
2528
use anyhow::Result;
2629

2730
fn main() -> Result<()> {
28-
let formula = Formula::new("UPPER(TRIM(' Hello '))")?;
29-
let value = formula.parse().unwrap();
31+
let formula = Formula::new("=UPPER(TRIM(' Hello '))")?;
32+
let value = formula.parse()?;
3033
assert_eq!(value, Expr::String("HELLO".to_string()));
3134
Ok(())
3235
}
3336
```
3437

35-
### What we do not support:
38+
### What we do not support, yet:
3639

37-
- We would like to add more functions, like Excel functions, Google Sheets functions, and more
40+
- Support of functions are so limited at the moment, but we would like to add more of them, like Excel functions, Google Sheets functions, and so on
3841
- At the moment, we don't support table data, so you need to pass values to the formula as arguments by yourself
39-
- We do not support simple formulas like `1+1` or as argument like `AND(1>3, 1<3)` or `SUM(2-1, 2)`, yet
42+
- We do not support simple formulas like `1+1` or as argument like `AND(1>3, 1<3)` or `SUM(2-1, 2)`. Instead, you can use our `F.` functions like `AND(F.GT(1, 3), F.LT(1, 3))` or `SUM(F.SUB(2, 1), 2)`
43+
- We still do not support parentheses to change the order of operations, but you can use our `F.` functions. So for example instead of `2*(1+1)`, you should use `F.MUL(2, F.ADD(1, 1))`
4044

4145
### Contributing
4246

@@ -45,3 +49,5 @@ We would love to have your contribution! Please read our [contributing guideline
4549
### License
4650

4751
This project is licensed under the MIT license. See the [LICENSE](LICENSE.md) file for more info.
52+
53+
License: MIT

0 commit comments

Comments
 (0)