docs: add usage instructions with npx command to README
This commit is contained in:
+44
@@ -0,0 +1,44 @@
|
||||
# DEV
|
||||
|
||||
## Standards
|
||||
|
||||
On suit ces deux guides :
|
||||
|
||||
- [GUIDE.md](./dev/GUIDE.md) : conventions générales de rédaction et de structure
|
||||
- [REDACTION.md](./dev/REDACTION.md) : règles de style, ton et formatage
|
||||
|
||||
---
|
||||
|
||||
## Publier le package
|
||||
|
||||
Le package `@zen/start` est publié sur le registre npm à `https://git.hyko.cx`.
|
||||
|
||||
### 1. Configurer l'authentification
|
||||
|
||||
Créer un token d'accès dans Gitea (Settings → Applications → Generate Token), puis l'enregistrer localement :
|
||||
|
||||
```bash
|
||||
npm config set //git.hyko.cx/api/packages/zen/npm/:_authToken TOKEN
|
||||
```
|
||||
|
||||
Remplacer `TOKEN` par le token généré.
|
||||
|
||||
### 2. Build et publish
|
||||
|
||||
```bash
|
||||
npm publish
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Bump de version
|
||||
|
||||
Modifier `"version"` dans `package.json` en suivant [semver](https://semver.org/) :
|
||||
|
||||
| Type | Version |
|
||||
|------|---------|
|
||||
| `fix` | PATCH `1.x.X` |
|
||||
| `feat` | MINOR `1.X.0` |
|
||||
| Breaking change | MAJOR `X.0.0` |
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user