-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from AKVorrat/integration-docs
updated integration docs
- Loading branch information
Showing
1 changed file
with
20 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,28 +17,37 @@ We created this tool to support the protest against the EU initiative to scan in | |
## Integrate | ||
Integrate the campaign in your Website | ||
|
||
**NOTE:** To be able to integrate DearMEP on your site, it is necessary to whitelist the URL of your site on the DearMEP server. Feel free to contact [[email protected]](mailto:[email protected]) if you would like to add DearMEP to your site. | ||
|
||
**Simple integration:** | ||
```html | ||
<link rel="stylesheet" href="http://chatcontrol.dearmep.eu/fonts.css" type="text/css" /> | ||
<dear-mep host="https://chatcontrol.dearmep.eu/api/" /> | ||
<script src="https://chatcontrol.dearmep.eu/dear-mep.js"></script> | ||
<link rel="stylesheet" href="https://chatcontrol.dearmep.eu/static/dear-mep.css" type="text/css"/> | ||
<dear-mep host="https://chatcontrol.dearmep.eu/"/></dear-mep> | ||
<script src="https://chatcontrol.dearmep.eu/static/dear-mep.js"></script> | ||
``` | ||
1. Include the fonts CSS | ||
1. Include the CSS | ||
2. Create the dear-mep Element with Parameters | ||
3. Include the dear-mep JS | ||
|
||
**Parameters for dear-mep Element** | ||
| Parameter | Description | | ||
|-----------|---------------------| | ||
| host | URL to dear-mep api | | ||
| Parameter | Description | | ||
|-------------------------|---------------------| | ||
| host | The URL of the DearMEP-Server. This attribute is required! | | ||
| api | The URL of the dear-mep API-Server. This attribute is used if the API-Server is hosted separately from the server that provides hosts static assets. | | ||
| assets | The URL of the Assets-Server. This attribute is used if the static assets are hosted separately from the API-Server. | | ||
| default‑country | If the user has not (yet) selected a country and the server cannot determine the country (because a VPN or TOR is used for example), this country will be used as fallback. It makes sense for a german campaign to use "DE" for example. Use two didgit country codes such as: "DE", "AT", ... . | | ||
| disable‑calling | If this attribute is present the calling functionality is hidden. | | ||
| disable‑scheduling | If this attribute is present the schedule-call functionality is hidden. NOTE: This functionality is not yet supported but it will be enabled by default as soon as it is. | | ||
|
||
**Integration with optional parameters:** | ||
```html | ||
<link rel="stylesheet" href="https://chatcontrol.dearmep.eu/fonts.css" type="text/css"> | ||
<link rel="stylesheet" href="https://chatcontrol.dearmep.eu/static/dear-mep.css" type="text/css"/> | ||
<dear-mep | ||
host="https://chatcontrol.dearmep.eu/api/" | ||
/> | ||
<script src="https://chatcontrol.dearmep.eu/dear-mep.js"></script> | ||
host="https://chatcontrol.dearmep.eu/" | ||
default-country="DE" | ||
disable-scheduling | ||
></dear-mep> | ||
<script src="https://chatcontrol.dearmep.eu/static/dear-mep.js"></script>s | ||
``` | ||
|
||
## Integrations | ||
|