diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 0ee9eba..861d2ac 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,22 +1,30 @@ # Installation -## 1. Install the package +## 1. Configurer le registre npm + +Créer un fichier `.npmrc` à la racine du projet avec le contenu suivant : + +``` +@hykocx:registry=https://git.hyko.cx/api/packages/hykocx/npm/ +``` + +## 2. Installer le package ```bash npm install @hykocx/zen ``` -## 2. Install the styles +## 3. Installer les styles -Add the following line to your `globals.css` file: +Ajouter la ligne suivante dans le fichier `globals.css` : ```css @import '@hykocx/zen/styles/zen.css'; ``` -## 3. Add ZenProvider to your root layout +## 4. Ajouter ZenProvider au layout racine -Wrap your application with the `ZenProvider` in your root layout to enable toast notifications globally: +Entourer l'application avec `ZenProvider` dans le layout racine pour activer les notifications toast globalement : ```javascript // app/layout.js @@ -40,21 +48,21 @@ export default function RootLayout({ children }) { } ``` -## 4. Configure the environment variables +## 5. Configurer les variables d'environnement -Check the [`.env.example`](.env.example) file for the required environment variables to add to your `.env` file. +Consulter le fichier [`.env.example`](.env.example) pour les variables d'environnement à ajouter dans le fichier `.env`. -## 5. Initialize the database +## 6. Initialiser la base de données ```bash npx zen-db init ``` -# Setup +# Configuration -## Quick Setup +## Configuration rapide -You can create all required files with a single command: +On peut créer tous les fichiers requis avec une seule commande : ```bash npx zen-setup init