Skip to content

Commit a299deb

Browse files
committed
Update section titles and improve content organization
1 parent aa212f5 commit a299deb

File tree

1 file changed

+20
-44
lines changed

1 file changed

+20
-44
lines changed

README.md

Lines changed: 20 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,28 @@
1010
1111
## Contents
1212

13-
- [Ways to Use FEAScript](#ways-to-use-feascript)
14-
- [FEAScript API](#feascript-api)
15-
- [Use FEAScript in the Browser](#use-feascript-in-the-browser)
16-
- [Use FEAScript with Node.js](#use-feascript-with-nodejs)
17-
- [Use FEAScript in JavaScript Playgrounds](#use-feascript-in-javascript-playgrounds)
18-
- [FEAScript Studio](#feascript-studio)
13+
- [How to Use FEAScript](#ways-to-use-feascript)
14+
- [Use FEAScript in the Browser](#use-feascript-in-the-browser)
15+
- [Use FEAScript with Node.js](#use-feascript-with-nodejs)
16+
- [Use FEAScript in JavaScript Playgrounds](#use-feascript-in-javascript-playgrounds)
1917
- [Quick Example](#quick-example)
2018
- [Support FEAScript](#support-feascript)
2119
- [Contributing](#contributing)
2220
- [License](#license)
2321

24-
## Ways to Use FEAScript
22+
## How to Use FEAScript
2523

26-
FEAScript offers two main approaches to creating simulations:
27-
28-
1. **[FEAScript API](#feascript-api)** – For developers comfortable with coding, providing full programmatic control in browsers, Node.js, or interactive notebooks.
29-
2. **[FEAScript Studio](#feascript-studio)** – A visual (based on [Blockly](https://blockly.com/)) and code-based environment for building simulations in the browser.
30-
31-
Each approach is explained in detail below.
32-
33-
### FEAScript API
34-
35-
The FEAScript API is the core programmatic interface for FEAScript. Written entirely in pure JavaScript, it runs in three environments:
24+
You can run simulations with FEAScript by calling its functions from JavaScript (the FEAScript API). The API is the core programmatic interface for FEAScript and works across multiple environments, including the browser (simple HTML pages and online JavaScript playgrounds, e.g. [CodePen](https://codepen.io/) and [Scribbler](https://scribbler.live/)) and server-side runtimes such as Node.js. The most common ways to use FEAScript are outlined below:
3625

3726
1. **[In the browser](#use-feascript-in-the-browser)** – Run FEAScript directly in a simple HTML page to perform simulations locally with no additional installations or cloud services required.
38-
2. **[With Node.js](#use-feascript-with-nodejs)**Use FEAScript in server-side JavaScript applications.
39-
3. **[In JavaScript playgrounds](#use-feascript-in-javascript-playgrounds)**Try FEAScript in interactive JavaScript playgrounds such as [CopePen](https://codepen.io/FEAScript) or [Scribbler](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples).
27+
2. **[In JavaScript playgrounds](#use-feascript-in-javascript-playgrounds)**Try FEAScript in interactive JavaScript playgrounds such as [CodePen](https://codepen.io/FEAScript) or [Scribbler](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples).
28+
3. **[With Node.js](#use-feascript-with-nodejs)**Use FEAScript in server-side JavaScript applications.
4029

4130
#### Use FEAScript in the Browser
4231

4332
You can use FEAScript in browser environments in three ways:
4433

4534
- **Import from Hosted ESM Build:**
46-
4735
```html
4836
<script type="module">
4937
import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
@@ -70,6 +58,15 @@ You can use FEAScript in browser environments in three ways:
7058

7159
👉 Explore browser-based tutorials on our [website](https://feascript.com/#tutorials).
7260

61+
#### Use FEAScript in JavaScript Playgrounds
62+
63+
FEAScript works well in interactive JavaScript playgrounds where you can write code, visualize results inline, and share your work.
64+
65+
👉 Explore the following examples:
66+
67+
- [CodePen (interactive pens)](https://codepen.io/FEAScript)
68+
- [Scribbler (notebooks)](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples)
69+
7370
#### Use FEAScript with Node.js
7471

7572
Install FEAScript and its peer dependencies from npm as follows:
@@ -95,27 +92,6 @@ When running examples from within this repository, this step isn’t needed as t
9592

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

98-
#### Use FEAScript in JavaScript Playgrounds
99-
100-
FEAScript works well in interactive JavaScript playgrounds where you can write code, visualize results inline, and share your work.
101-
102-
👉 Explore the following examples:
103-
104-
- [CodePen (interactive pens)](https://codepen.io/FEAScript)
105-
- [Scribbler (notebooks)](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples)
106-
107-
### FEAScript Studio
108-
109-
For users who prefer a visual approach to creating simulations, [FEAScript Studio](https://feascript.com/feascript-studio.html) offers a browser-based visual editor that allows you to:
110-
111-
- Build and run finite element simulations directly in your browser by connecting visual blocks together (based on the [Blockly](https://blockly.com/) library).
112-
- Combine a no-code workflow with an integrated code editor when you need more control.
113-
- Save and share projects.
114-
115-
While the FEAScript API provides full programmatic control for advanced customization, FEAScript Studio offers a visual interface for creating and editing simulations.
116-
117-
Join the [waitlist](https://feascript.com/feascript-studio.html#waitlist) to get updates about FEAScript Studio and be among the first to try it when it’s released.
118-
11995
## Quick Example
12096

12197
Here is a minimal browser-based example using the FEAScript API. Adapt paths, physics model, and boundary conditions as needed for your specific problem:
@@ -157,7 +133,7 @@ Here is a minimal browser-based example using the FEAScript API. Adapt paths, ph
157133

158134
**Note:** The code above uses placeholder values that you should replace with appropriate options, e.g.:
159135

160-
- "solverType" should be replaced with an actual solver type such as "heatConductionScript" for heat conduction problems
136+
- "physicsModel" should be replaced with an actual solver type such as "heatConductionScript" for heat conduction problems
161137
- "conditionType" should be replaced with an actual boundary condition type such as "constantTemp"
162138
- "boundaryIndex" should be replaced with a string identifying the boundary
163139

@@ -166,10 +142,10 @@ Here is a minimal browser-based example using the FEAScript API. Adapt paths, ph
166142
> 💖 **If you find FEAScript useful, please consider supporting its development through a donation:**
167143
168144
<a href="https://github.com/sponsors/FEAScript">
169-
<img alt="GitHub Sponsors" src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/feascript">
145+
<img alt="GitHub Sponsors" src="https://feascript.github.io/FEAScript-website/assets/Sponsor_GitHub.svg">
170146
</a>
171147
<a href="https://liberapay.com/FEAScript/donate">
172-
<img alt="Donate using Liberapay" src="https://img.shields.io/badge/Liberapay-F6C915?logo=liberapay&logoColor=black">
148+
<img alt="Donate using Liberapay" src="https://feascript.github.io/FEAScript-website/assets/Sponsor_Liberapay.svg">
173149
</a>
174150

175151
Your support helps ensure the continued development and maintenance of this project.

0 commit comments

Comments
 (0)