Skip to content

Commit b079acd

Browse files
committed
docs: add French README section and GitHub Actions CI
1 parent 564a658 commit b079acd

2 files changed

Lines changed: 41 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CI
2+
on:
3+
push:
4+
branches: [master]
5+
pull_request:
6+
branches: [master]
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
strategy:
11+
matrix:
12+
node-version: [18, 20]
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version: ${{ matrix.node-version }}
18+
cache: npm
19+
- run: npm ci
20+
- run: npm test

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,3 +229,24 @@ MIT
229229
## Performance
230230

231231
Benchmarks against React fiber and Preact coming soon.
232+
233+
---
234+
235+
## 🇫🇷 Documentation en français
236+
237+
### Description
238+
virtual-dom-engine est une implémentation de DOM virtuel construite de zéro en TypeScript à des fins éducatives. Ce projet démontre les concepts fondamentaux derrière des bibliothèques comme React : création d'arbres de nœuds virtuels, algorithme de diff et patching efficace du DOM réel. Une ressource précieuse pour comprendre les bases du rendu déclaratif en JavaScript.
239+
240+
### Installation
241+
```bash
242+
npm install
243+
```
244+
245+
### Utilisation
246+
```typescript
247+
import { h, render, diff, patch } from './src';
248+
249+
const vdom = h('div', { class: 'app' }, h('p', {}, 'Bonjour'));
250+
render(vdom, document.getElementById('root'));
251+
```
252+
Consultez la documentation en anglais ci-dessus pour les détails de l'algorithme de diff et les exemples d'utilisation.

0 commit comments

Comments
 (0)