mochikao 0.1.1 → 0.1.3

package/README.fr.md

@@ -2,6 +2,8 @@
 
 [English](README.md) · **Français**
 
+[Site](https://mochikao.alexvolkihar.ovh) · [npm](https://www.npmjs.com/package/mochikao) · [GitHub](https://github.com/Alexvolkihar/mochikao)
+
 Un visage pour chaque nom. `mochikao` transforme n'importe quelle chaîne (pseudo, e-mail, id) en un petit personnage SVG. Le même nom donne toujours le même mochikao.
 
 ![Page d'accueil de mochikao : un nom tapé, l'avatar généré et le choix d'expression](docs/home.png)
@@ -20,6 +22,21 @@ Un visage pour chaque nom. `mochikao` transforme n'importe quelle chaîne (pseud
 
 Inspiré de [blobatar](https://blobatar.dev).
 
+## Quand l'utiliser
+
+- **Avatars par défaut** pour les utilisateurs sans photo : donne-lui un pseudo ou un id et chaque compte a un visage, sans rien à stocker.
+- **Personnes anonymes ou pseudonymes** : commentateurs, participants d'un chat ou d'un jeu multijoueur, invités, relecteurs. Chacun se reconnaît d'un coup d'œil sans révéler qui il est.
+- **Maquettes et données de test** dans des listes, démos et captures d'écran, à la place des ronds gris ou des photos de banque d'images.
+- **Partout où l'on ne peut pas ou ne veut pas appeler un service** : l'avatar se calcule à partir de la seule chaîne, donc il s'affiche pareil dans le navigateur, sur le serveur, en edge ou dans un script, sans requête réseau.
+- **Un visage qui montre une humeur** : les 8 expressions collent à des statuts (`thinking` pendant un chargement, `sick` sur une erreur, `happy` après un succès) sans que le personnage change.
+- **Un style ludique et reconnaissable** pour une communauté, un jeu ou un projet perso, quand un identicon générique paraît trop froid.
+
+Quand **ne pas** l'utiliser :
+
+- Il te faut une vraie photo ou une identité vérifiée. Un mochikao est un remplaçant, pas une preuve de qui est la personne.
+- Il te faut une unicité garantie pour chaque utilisateur. Deux noms différents peuvent, en théorie, se ressembler.
+- Choisis une **clé stable** (un id plutôt qu'un pseudo que l'utilisateur peut renommer) : si la chaîne change, le visage change.
+
 ## Démarrer
 
 ```bash
@@ -142,6 +159,8 @@ Mêmes attributs que les options ; `gaze` fait suivre le pointeur aux yeux.
 GET /api/<nom>.svg?size=&bg=&hue=&tone=&color=&expression=&animate=&family=&shape=&eyes=&mouth=&extra=
 ```
 
+Instance hébergée : `https://mochikao.alexvolkihar.ovh/api/<nom>.svg`. À essayer dans l'[éditeur](https://mochikao.alexvolkihar.ovh/editor.html).
+
 Réponse `image/svg+xml` avec `Cache-Control: immutable` (même entrée → même sortie). Les paramètres invalides sont ignorés. Le handler (`api/handler.ts`) est une simple fonction `(req, res)` de `node:http`, à brancher où tu veux.
 
 ### CLI

package/README.md

@@ -2,6 +2,8 @@
 
 **English** · [Français](README.fr.md)
 
+[Website](https://mochikao.alexvolkihar.ovh) · [npm](https://www.npmjs.com/package/mochikao) · [GitHub](https://github.com/Alexvolkihar/mochikao)
+
 A face for every name. `mochikao` turns any string (username, email, ID) into a little SVG character. The same name always gives the same mochikao.
 
 ![mochikao home page: a typed name, the generated avatar and the expression picker](docs/home.png)
@@ -20,6 +22,21 @@ A face for every name. `mochikao` turns any string (username, email, ID) into a
 
 Inspired by [blobatar](https://blobatar.dev).
 
+## When to use it
+
+- **Default avatars** for users who haven't uploaded a photo: feed it a username or an ID and every account gets a face, with nothing to store.
+- **Anonymous or pseudonymous people**: commenters, chat and multiplayer participants, guest users, reviewers. Each one is recognizable at a glance without revealing who they are.
+- **Placeholders and seed data** in lists, mockups, demos and screenshots, instead of grey circles or stock photos.
+- **Anywhere you can't or don't want to call a service**: the avatar is computed from the string alone, so it renders the same in the browser, on the server, at the edge or in a script, with no network request.
+- **A face that shows a mood**: the 8 expressions fit statuses (`thinking` while loading, `sick` on an error, `happy` on success) while the character stays the same.
+- **A playful, recognizable look** for a community, a game or a side project, where a generic identicon feels too cold.
+
+When **not** to use it:
+
+- You need a real photo or a verified identity. A mochikao is a stand-in, not proof of who someone is.
+- You need every user to be guaranteed unique. Two different names can, in theory, look alike.
+- Pick a **stable key** (an ID rather than a pseudonym a user can rename): change the string and the face changes.
+
 ## Getting started
 
 ```bash
@@ -142,6 +159,8 @@ Same attributes as the options; `gaze` makes the eyes follow the pointer.
 GET /api/<name>.svg?size=&bg=&hue=&tone=&color=&expression=&animate=&family=&shape=&eyes=&mouth=&extra=
 ```
 
+Hosted instance: `https://mochikao.alexvolkihar.ovh/api/<name>.svg`. Try it in the [editor](https://mochikao.alexvolkihar.ovh/editor.html).
+
 Responds with `image/svg+xml` and `Cache-Control: immutable` (same input → same output). Invalid parameters are ignored. The handler (`api/handler.ts`) is a plain `node:http` `(req, res)` function you can mount anywhere.
 
 ### CLI

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mochikao",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Deterministic avatars: any string becomes a cute, unique SVG character. Zero dependencies, React / Vue / Svelte / Solid / web component.",
   "keywords": [
     "avatar",
@@ -22,7 +22,7 @@
     "type": "git",
     "url": "git+https://github.com/Alexvolkihar/mochikao.git"
   },
-  "homepage": "https://github.com/Alexvolkihar/mochikao#readme",
+  "homepage": "https://mochikao.alexvolkihar.ovh",
   "bugs": {
     "url": "https://github.com/Alexvolkihar/mochikao/issues"
   },