Skip to content

Commit 2687fdd

Browse files
committed
Add doc
1 parent 8b9a97c commit 2687fdd

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ Repo containing code of:
55
- [@gouvfr-lasuite/integration npm package](https://www.npmjs.com/package/@gouvfr-lasuite/integration) in [`packages/integration`](./packages/integration/)
66
- [La Suite: integration docs and API](https://integration.lasuite.numerique.gouv.fr/) in [`website`](./website/)
77

8+
# Adapting to your needs
9+
10+
This repository allows you to configure your version of La Gaufre. It contains a github action that will build it as a static website and host it on GitHub Pages, by default under `https://<yourname>.github.io/integration` once you fork it and enable Pages.
11+
12+
You can configure La Gaufre by editing [website/src/data/services.json](website/src/data/services.json) (see file for DINUM default values) and adding the required logos with names `$id.svg` into [website/src/assets/logos/](website/src/assets/logos/).
13+
14+
## Using La Gaufre
15+
16+
In your application, add a `button` with the class `js-lasuite-gaufre-btn`, and include the js `https://<yourname>.github.io/integration/api/v1/gaufre.js` in a script element using id `lasuite-gaufre-script`. If necessary, you'll need to whitelist `https://<yourname>.github.io/` in relevant CORS and/or CSP.
17+
18+
If you are using the css from DINUM, you may also want to add classes `lasuite-gaufre-btn--vanilla js-lasuite-gaufre-btn` and either `lasuite-gaufre-btn--responsive`(responsive design) or `lasuite-gaufre-btn--small`(small design).
19+
20+
Clicking the button should then load `https://<yourname>.github.io/integration/api/v1/gaufre/`.
21+
22+
823
## Licenses
924

1025
Source code is released under the [MIT](LICENSES/MIT.txt) and other

0 commit comments

Comments
 (0)