fr-zip-codes - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

package.json

 {
   "name": "fr-zip-codes",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "French zip codes API for Node.js",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -1,3 +0,2 @@
-Codes postaux
-------
+## Codes postaux
 
@@ -10,11 +9,4 @@ Ce dépôt contient les scripts permettant de générer le [fichier des codes postaux](https://www.data.gouv.fr/fr/datasets/5a9ac6b9c751df4caed2b133/) ainsi qu'un module [Node.js](https://nodejs.org) permettant de l'interroger facilement.
 
-Les données de base sont produites à partir du [Code Officiel Géographique](https://www.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/) de l'INSEE et du  [FIMOCT](https://www.data.gouv.fr/fr/datasets/5a3cc6b588ee3858d95178fc/) de la DGFiP.
+Les données de base sont produites à partir du [Code Officiel Géographique](https://www.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/) de l'INSEE et du [FIMOCT](https://www.data.gouv.fr/fr/datasets/5a3cc6b588ee3858d95178fc/) de la DGFiP.
 
-### Production
-
-```bash
-npm install
-npm run build
-```
-
 ## Module JavaScript
@@ -24,21 +16,25 @@
 
-`$ npm install codes-postaux --save`
+`$ yarn add fr-zip-codes --save`
 
 ### Utilisation
+
 ```js
-const codesPostaux = require('codes-postaux');
+const frZipCodes = require("fr-zip-codes");
 
-codesPostaux.find(75001);
-codesPostaux.find('75001');
+frZipCodes.find(75001);
+frZipCodes.find("75001");
 ```
 
 Retourne
+
 ```js
-[ { codeCommune: '75101',
-    nomCommune: 'Paris 1er Arrondissement',
-    codePostal: '75001',
-    libelleAcheminement: 'PARIS' } ]
+[
+  {
+    townCode: "75101",
+    zipCode: "75001",
+    routingLabel: "PARIS",
+  },
+];
 ```
 
-
 ## Communes mortes pour la France
@@ -50,8 +46,8 @@
 const COMMUNES_MORTES_POUR_LA_FRANCE = [
-  '55039',
-  '55050',
-  '55239',
-  '55307',
-  '55139',
-  '55189'
+  "55039",
+  "55050",
+  "55239",
+  "55307",
+  "55139",
+  "55189",
 ];
@@ -62,9 +58,9 @@ ```
 
-| Nom de la bibliothèque | Langage | Auteur |
-| --- | --- | --- |
-| [codes_postaux](https://github.com/Kleak/code_postaux) | Dart | [Kleak](https://github.com/Kleak) |
+| Nom de la bibliothèque                                 | Langage | Auteur                            |
+| ------------------------------------------------------ | ------- | --------------------------------- |
+| [codes_postaux](https://github.com/Kleak/code_postaux) | Dart    | [Kleak](https://github.com/Kleak) |
 
 ## Et les données de La Poste ?
 
-__Pourquoi ne pas utiliser la [base officielle des codes postaux](https://www.data.gouv.fr/fr/datasets/545b55e1c751df52de9b6045/) produite par La Poste ?__
+**Pourquoi ne pas utiliser la [base officielle des codes postaux](https://www.data.gouv.fr/fr/datasets/545b55e1c751df52de9b6045/) produite par La Poste ?**
 
@@ -71,0 +67,0 @@ Les données produites par La Poste sont diffusées sous [licence ODbL](https://fr.wikipedia.org/wiki/Open_Database_License), ce qui implique que toute base de données dérivée doit être diffusée sous cette même licence.

No alert changes

Improved metrics

Total package byte prevSize

2554953

Worsened metrics

Number of lines in readme file

66

decreased by-5.71%

No dependency changes