docs: minimal readme

README.md

@@ -1,3 +1,26 @@
-# rjsf-dsfr
+# React JSON Schema Form with the DSFR
 
-react-jsonschema-form for the DSFR
+This is a wrapper around the
+[react-jsonschema-form](https://rjsf-team.github.io/react-jsonschema-form/docs/)
+with the components from
+[`react-dsfr`](https://github.com/codegouvfr/react-dsfr).
+
+> [!IMPORTANT]
+> For now, this is simply extracted code from
+> [`catala-dsfr`](https://github.com/CatalaLang/catala-dsfr).
+> Therefore, the API is not yet defined and and is likely to be not flexible
+> enough for your use case.
+>
+> If you want to use this library, please [open an
+> issue](https://github.com/codegouvfr/rjsf-dsfr/issues) to discuss your needs!
+
+## Installation
+
+```bash
+yarn add @codegouvfr/rjsf-dsfr
+```
+
+## Usage
+
+For now, the API matches the one from `react-jsonschema-form` and you can
+overrides some widgets (resp. templates) by specifying them in the props.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codegouvfr/rjsf-dsfr",
   "version": "0.1.0",
-  "description": "react-jsonschema-form for the DSFR",
+  "description": "react-jsonschema-form with the DSFR",
   "repository": "[email protected]:codegouvfr/rjsf-dsfr.git",
   "author": "Emile Rolley <[email protected]>",
   "keywords": [