Skip to content

Commit

Permalink
Doc consommation via URL des données des packages
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasG77 committed Mar 30, 2022
1 parent 297d3b2 commit 19b9451
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,36 @@ yarn add @etalab/decoupage-administratif

## Utilisation

### Node

```js
const communes = require('@etalab/decoupage-administratif/data/communes.json')
const departements = require('@etalab/decoupage-administratif/data/departements.json')
const regions = require('@etalab/decoupage-administratif/data/regions.json')
const arrondissements = require('@etalab/decoupage-administratif/data/arrondissements.json')
const epci = require('@etalab/decoupage-administratif/data/epci.json')
```

### via des URLs

Pour la dernière version

- Communes https://unpkg.com/@etalab/decoupage-administratif/data/communes.json
- Départements https://unpkg.com/@etalab/decoupage-administratif/data/departements.json
- Régions https://unpkg.com/@etalab/decoupage-administratif/data/regions.json
- Arrondissements https://unpkg.com/@etalab/decoupage-administratif/data/arrondissements.json
- EPCI https://unpkg.com/@etalab/decoupage-administratif/data/epci.json

Il est possible de rajouter une version. Pour les EPCI 2021, par exemple https://unpkg.com/@etalab/decoupage-administratif@1.1.1/data/epci.json (voir le lien millésime et version de packages)

## Millésimes et versions de package

Vous avez besoin de données selon une année? Voici un tableau récapitulatif pour choisir:

| Année | Version du package | NPM | Yarn |
|-------|-------------------------------------------|---------------------------------------------------|----------------------------------------------------|
| 2022 | 2.0.0 | `npm install @etalab/decoupage-administratif@2.0.0` | `yarn install @etalab/decoupage-administratif@2.0.0` |
| 2021 | 1.1.0 | `npm install @etalab/decoupage-administratif@1.1.1` | `yarn install @etalab/decoupage-administratif@1.1.1` |
| 2021 | 1.1.1 | `npm install @etalab/decoupage-administratif@1.1.1` | `yarn install @etalab/decoupage-administratif@1.1.1` |
| 2020 | Non disponible, sauf EPCI 2020 avec 0.8.0 | `npm install @etalab/decoupage-administratif@0.8` | `yarn install @etalab/decoupage-administratif@0.8` |
| 2019 | 0.7 | `npm install @etalab/decoupage-administratif@0.7` | `yarn install @etalab/decoupage-administratif@0.7` |

Expand Down

0 comments on commit 19b9451

Please sign in to comment.