Skip to content

Commit df703e5

Browse files
committed
Update README.md with additional SIMD example and usage instructions
1 parent 42bcdbb commit df703e5

2 files changed

Lines changed: 21 additions & 13 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
[![Build ARnft CI](https://github.com/webarkit/ARnft/actions/workflows/build.yml/badge.svg)](https://github.com/webarkit/ARnft/actions/workflows/main.yml)
99
![twitter](https://flat.badgen.net/badge/twitter/WebarkitO/follow)
1010

11-
# ARnft - WebAR with NFT
11+
# πŸ–ΌοΈ ARnft - WebAR with NFT
1212

1313
<img alt="ARnft official logo" src="examples/Data/arNFT-logo.gif" width="250px"/>
1414

1515
A small javascript library to develop WebAR apps. It is based on [jsartoolkitNFT](https://github.com/webarkit/jsartoolkitNFT) a lighter version of jsartoolkit5 only with **NFT** markerless technology. It uses [ARnft-threejs](https://github.com/webarkit/ARnft-threejs) for the rendering part.
1616

17-
## Start using it !
17+
## πŸš€ Start using it !
1818

1919
:one: &nbsp; Clone the repository:
2020

@@ -40,7 +40,15 @@ http://localhost:8000/examples/arNFT_example.html
4040

4141
<img alt="pinball image" src= https://raw.githubusercontent.com/artoolkitx/artoolkit5/master/doc/Marker%20images/pinball.jpg width="250"/>
4242

43-
## Usage
43+
## 🏎️ SIMD Feature
44+
45+
The ARnft library now includes support for SIMD (Single Instruction, Multiple Data) to enhance performance by parallelizing data processing tasks. This feature is particularly useful for applications requiring high computational power, such as augmented reality.
46+
47+
To see the SIMD feature in action, you can try the `arNFT_simd_example.html` example:
48+
49+
http://localhost:8000/examples/arNFT_example.simd.html
50+
51+
## πŸ“¦ Usage
4452

4553
Download the zipped dist lib package from the releases page: [webarkit/ARnft/releases](https://github.com/webarkit/ARnft/releases)
4654
and import it as a module:
@@ -62,7 +70,7 @@ and import it as a module:
6270
const { ARnft } = arnft;
6371
import ARnftThreejs from "arnft-threejs";
6472
const { SceneRendererTJS, NFTaddTJS } = ARnftThreejs;
65-
73+
6674
// Follow code for rendering ect. see the examples.
6775
```
6876
@@ -103,15 +111,15 @@ or if you want to import as a module with npm:
103111
import { ARnft } from "@webarkit/ar-nft";
104112
```
105113
106-
107-
## Examples
114+
## πŸ§ͺ Examples
108115
109116
Test the examples in the `/examples` folder:
110117
111118
- `arNFT_autoupdate_example.html` Example with the autopdate routine.
112119
- `arNFT_container_example.html` Example with an alternative container.
113120
- `arNFT_event_example.html` Example with objVisibility and eventListener.
114121
- `arNFT_example.html` The simplest example displaying a red cube.
122+
- `arNFT_simd_example.html` Example with SIMD feature.
115123
- `arNFT_gltf_brave_robot_example.html` More advanced example with a gltf model and threejs events.
116124
- `arNFT_gltf_example.html` Example showing a gltf model (Duck).
117125
- `arNFT_gltf_flamingo_example.html` Example showing an animated gltf model (Flamingo).
@@ -124,19 +132,19 @@ Test the examples in the `/examples` folder:
124132
125133
You can try also a live example with React at this link: [kalwalt.github.io/ARnft-ES6-react/](https://kalwalt.github.io/ARnft-ES6-react/)
126134
127-
## Donate
135+
## πŸ’° Donate
128136
Donate to **ARnft** ![opencollective](https://flat.badgen.net/badge/icon/opencollective?icon=opencollective&label) ![backers](https://flat.badgen.net/opencollective/backers/arnft)
129137
130-
131-
## Documentation
138+
## πŸ“š Documentation
132139
133140
You can build the docs with this command:
134141
`yarn docs`
135142
Then run a live server and go to the docs' folder.
136143
137-
## Features
144+
## 🌟 Features
138145
139146
- **NFT** (**N**atural **F**eature **T**racking) Markers, read my article: [NFT natural feature tracking with jsartoolkit5](https://www.kalwaltart.com/blog/2020/01/21/nft-natural-feature-tracking-with-jsartoolkit5/)
147+
- **SIMD** (Single Instruction, Multiple Data) support for enhanced performance.
140148
- **ES6** standard. You can install it as a npm package and use it as a module (experimental). Install it with npm:
141149
142150
```
@@ -153,10 +161,10 @@ yarn add @webarkit/ar-nft
153161
154162
- Filtering of the matrix with the **O**ne**E**uro**F**ilter.
155163
156-
## Format the code with Prettier
164+
## πŸ› οΈ Format the code with Prettier
157165
We are using [Prettier](https://prettier.io/) as code formatter. You only need to run `yarn format` to write the formatted code with Prettier. If you want to check if the code is well formatted run instead: `yarn format-check`
158166
159-
## Build
167+
## πŸ”§ Build
160168
If you make changes to the code, run these commands to build the distribution library, install all the dependencies with:
161169
```
162170
yarn --include=dev i
@@ -168,4 +176,4 @@ yarn dev-ts
168176
Instead for a production build, with more optimizations in the code and smaller size, run:
169177
```
170178
yarn build-ts
171-
```
179+
```

0 commit comments

Comments
Β (0)