Skip to content

Commit b45f81a

Browse files
committed
Add features section on README
1 parent 28428e0 commit b45f81a

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,22 @@
1010

1111
> 🚧 **FEAScript is currently under heavy development.** Its functionality and interfaces may change rapidly as new features and enhancements are introduced.
1212
13-
## Contents
13+
## Features
14+
15+
- <b>Physics models:</b> creeping (Stokes) flow, front propagation, heat conduction
16+
- <b>Meshing:</b> simple 1D/2D mesh generation, unstructured mesh import from Gmsh (`.msh`)
17+
- <b>Solvers:</b> frontal, Jacobi (CPU/WebGPU) and LU, Newton–Raphson for nonlinear systems
18+
- <b>Performance:</b> web worker support for multi-threaded computation
19+
- <b>Visualization:</b> interactive plots with Plotly
20+
21+
<!-- ## Contents
1422
1523
- [How to Use FEAScript](#ways-to-use-feascript)
16-
- [Use FEAScript in the Browser](#use-feascript-in-the-browser)
17-
- [Use FEAScript with Node.js](#use-feascript-with-nodejs)
18-
- [Use FEAScript in JavaScript Playgrounds](#use-feascript-in-javascript-playgrounds)
19-
- [Quick Example](#quick-example)
24+
- [Features](#features)
25+
- [Examples](#examples)
2026
- [Support FEAScript](#support-feascript)
2127
- [Contributing](#contributing)
22-
- [License](#license)
28+
- [License](#license) -->
2329

2430
## How to Use FEAScript
2531

@@ -95,7 +101,7 @@ When running examples from within this repository, this step isn’t needed as t
95101

96102
👉 Explore Node.js use cases on the [examples directory](https://github.com/FEAScript/FEAScript-core/tree/main/examples).
97103

98-
## Quick Example
104+
## Examples
99105

100106
Here is a minimal browser-based example using the FEAScript API. Adapt paths, physics model, and boundary conditions as needed for your specific problem:
101107

0 commit comments

Comments
 (0)