Skip to content

Commit 35d1ed7

Browse files
docs: add basic README (#52)
## Summary - add French README with installation, usage, and development instructions ## Testing - `npm test` (fails: Missing script "test") - `npm run build` (fails: tsup: not found) ------ https://chatgpt.com/codex/tasks/task_e_689cbd6289bc83248d54f004c2bc6f54
2 parents d2d9df5 + 3d082fe commit 35d1ed7

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Picko Tools
2+
3+
Bibliothèque de composants React pour afficher des statistiques de surveillance depuis la plateforme [Picko](https://picko.jeremiemeunier.fr).
4+
5+
## Installation
6+
7+
```bash
8+
npm install @jeremiemeunier/picko-package
9+
```
10+
11+
Assurez‑vous d'avoir configuré l'accès au registre GitHub Packages pour le scope `@jeremiemeunier`.
12+
13+
## Utilisation rapide
14+
15+
```tsx
16+
import { PickoProvider, PickoCard } from "@jeremiemeunier/picko-package";
17+
18+
export default function App() {
19+
return (
20+
<PickoProvider>
21+
<PickoCard>
22+
<PickoCard.Live color="cyan" />
23+
<PickoCard.History color={{ positive: "green", negative: "red" }} />
24+
<PickoCard.Tracker />
25+
<PickoCard.Spark color="cyan" />
26+
</PickoCard>
27+
</PickoProvider>
28+
);
29+
}
30+
```
31+
32+
`PickoProvider` se charge de récupérer les données de votre domaine et met ces informations à disposition des composants `PickoCard`.
33+
34+
## Développement
35+
36+
```bash
37+
npm install
38+
npm run build
39+
```
40+
41+
La commande `npm run build` utilise [tsup](https://github.com/egoist/tsup) pour générer les fichiers compilés dans `dist/`.
42+
43+
## Licence
44+
45+
Ce projet est publié sous licence [ISC](./LICENSE).
46+

0 commit comments

Comments
 (0)