Skip to content

Commit b8b181d

Browse files
committed
update
1 parent 01f2ae6 commit b8b181d

3 files changed

Lines changed: 59 additions & 0 deletions

File tree

docs/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
layout: default
3+
title: Exprify Docs
4+
---
5+
6+
# Exprify Docs
7+
8+
Exprify is a JavaScript expression parser and evaluator for math-heavy apps.
9+
10+
## Highlights
11+
12+
- arithmetic, precedence, bigint, and booleans
13+
- variables, assignments, and inline functions
14+
- unit conversion
15+
- matrices and linear algebra helpers
16+
- complex numbers
17+
- symbolic helpers like `simplify`, `derivative`, and `rationalize`
18+
19+
## Quick Example
20+
21+
```js
22+
import Exprify from "exprify";
23+
24+
const expr = new Exprify();
25+
26+
expr.evaluate("hyp(a, b) = sqrt(a ^ 2 + b ^ 2)");
27+
console.log(expr.evaluate("hyp(3, 4)"));
28+
// 5
29+
```
30+
31+
## References
32+
33+
- [Project README](../README.md)
34+
- [Token Type Notes](./tokenType.txt)

docs/assets/css/style.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
---
3+
4+
@import "jekyll-theme-primer";

docs/tokenType.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Token notes for Exprify
2+
3+
- Number
4+
- BigInt
5+
- Boolean
6+
- String
7+
- Identifier
8+
- Function
9+
- Operator
10+
- UnaryOperator
11+
- Keyword
12+
- Unit
13+
- NumberWithUnit
14+
- ImaginaryLiteral
15+
- Parenthesis
16+
- ArrayStart / ArrayEnd
17+
- BlockStart / BlockEnd
18+
- Comma
19+
- Semicolon
20+
- Colon
21+
- Dot

0 commit comments

Comments
 (0)