@betagouv/france-chaleur-urbaine-publicodes - npm Package Compare versions

Comparing version 0.4.0 to 0.6.2

package.json

 {
   "name": "@betagouv/france-chaleur-urbaine-publicodes",
-  "version": "0.4.0",
+  "version": "0.6.2",
   "repository": {
@@ -5,0 +5,0 @@ "type": "git",

README.md

@@ -19,36 +19,30 @@ <div align="center">
 
-## Usage
 
-Ajouter le paquet à vos dépendances :
+### Usage
 
 ```sh
-yarn add @betagouv/france-chaleur-urbaine-publicodes
+# installe les dépendances
+yarn install
+
+# compile le modèle publicodes en un fichier JSON et lance la documentation (mode watch)
+yarn dev
 ```
 
-Instancier un nouveau moteur Publicode :
 
-```typescript
-import Engine from "publicodes"
-import rules from "@betagouv/france-chaleur-urbaine-publicodes"
+### Publier une nouvelle version
 
-const engine = new Engine(rules)
+Afin de publier une nouvelle version il suffit d'exécuter la commande `npm version`, pour créer un commit avec la nouvelle version dans le package.json et faire un tag git.
+```sh
+# prochaine version v0.X.0
+npm version minor
+```
 
-engine.evaluate("dépenses primeur")
+Il ne reste alors plus qu'à pousser le commit et le tag pour créer une release sur le [registre NPM](https://www.npmjs.com/package/@betagouv/france-chaleur-urbaine-publicodes).
+```sh
+git push && git push --tags
 ```
 
-Utiliser certaines règles dans un autre modèle publicodes :
 
-```yaml
-importer!:
-  depuis:
-    nom: @betagouv/france-chaleur-urbaine-publicodes
-    url: https://github.com/betagouv/france-chaleur-urbaine-publicodes
-  les règles:
-    - prix . carottes
-    - prix . carottes
-    - prix . avocats
-```
+### Détail des commandes
 
-### En local
-
 #### Compiler le modèle
@@ -82,3 +76,3 @@
 
-#### Lancer l'API
+#### Lancer l'API (non utilisé)
 
@@ -96,5 +90,1 @@ > Le code de l'API est disponible dans le workspace
 ```
-
-## Publier une nouvelle version (manuellement pour le moment)
-
-Afin de publier une nouvelle version il suffit d'exécuter la commande `yarn publish`.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

571320

decreased by-0.04%

Number of lines in readme file

88

decreased by-10.2%

No dependency changes