Skip to content

Commit fcb9231

Browse files
committed
docs: update README to include additional details and clarifications
1 parent 26bab1f commit fcb9231

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
![NPM Type Definitions](https://img.shields.io/npm/types/fignumbers)
55
![NPM License](https://img.shields.io/npm/l/fignumbers)
66

7-
**Fignumbers** is a TypeScript library for generating *figurate numbers*, numbers that can be visualized as geometric shapes.
7+
**Fignumbers** is a comprehensive TypeScript library designed to generate and explore *figurate numbers*, numbers that can be visualized as geometric shapes in 2D, 3D, and higher-dimensional spaces.
88

9-
Based on Figurate Numbers (2012) by Elena and Michel Deza, it implements a variety of infinite sequences corresponding to shapes in 2D, 3D, and beyond.
9+
Based on the book Figurate Numbers (2012) by Elena and Michel Deza, this library supports a wide range of infinite sequences.
1010

1111
## Why fignumbers? 🚀
1212

@@ -15,16 +15,15 @@ Based on Figurate Numbers (2012) by Elena and Michel Deza, it implements a varie
1515

1616
### BigInt Support Required ⚠️
1717

18-
Fignumbers uses `BigInt` to handle large integers beyond the `Number` type limit `(2^53 - 1)`.
19-
Ensure your environment supports **BigInt** before using this library.
18+
Fignumbers utilizes `BigInt` to manage large integers that exceed the `Number` type limit of `(2^53 - 1)`. Ensure that your environment supports **BigInt** before using this library.
2019

2120
## Three main classes ⚙️
2221

23-
**Fignumbers** is structured around three main classes based on their spatial dimensions (as detailed in the book). These are:
22+
**Fignumbers** is structured around three main classes, each corresponding to a different spatial dimension, as described in the book:
2423

25-
1. PlaneFigNumbers = 10
26-
2. SpaceFigNumbers = 19
27-
3. MultiDimensionalFigNumbers = 15
24+
1. `PlaneFigNumbers` = 10
25+
2. `SpaceFigNumbers` = 19
26+
3. `MultiDimensionalFigNumbers` = 17
2827

2928
Each class offers specialized methods for generating different types of figurate numbers.
3029

0 commit comments

Comments
 (0)