readme

README.md

@@ -7,3 +7,24 @@ configs:
   - config_name: raw
     data_files: "data/datagouvfr-datasets-raw.csv"
 ---
+
+# datagouvfr-datasets
+
+This dataset is created from [data.gouv.fr's catalog](https://www.data.gouv.fr/en/datasets/catalogue-des-donnees-de-data-gouv-fr/), i.e. the French official open data platform list of datasets.
+
+data.gouv.fr's datasets with `archived` status or with no associated ressource are excluded.
+
+This has two configs, described below.
+
+## compact
+
+This config exposes 3 features:
+- `id`
+- `content`
+- `tags`
+
+`content` is the concatenation of the dataset's title and its description, stripped from markdown (markdown to text).
+
+## raw
+
+All columns from the original catalog, with the preprocess filter described above. Description is still in markdown.