diff --git a/.gitignore b/.gitignore index 54fec90..1646dc9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ .venv **/__pycache__ + apikey.yml +domains.json diff --git a/README.md b/README.md index 47c7656..2acd8d0 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ Python libraries: Install the [dependencies](#dependencies), preferrably using your system's package manager. Next, you will need your Ionos API keypair. -Clone the repo and create a file called `apikey.yml` at the project root. -Inside the file, paste your Ionos API-keypair in the following format: +Clone the repo and edit the file `apikey.yml`. +Inside the file, paste the respective value of your Ionos API-keypair, following this format: ```yaml --- @@ -26,6 +26,8 @@ apikey: ... ``` +This file **must be kept secret**. + ### Adding target domains Add every domain you want to send an update for to the file `domains.json`. diff --git a/apikey.yml b/apikey.yml new file mode 100644 index 0000000..05722ab --- /dev/null +++ b/apikey.yml @@ -0,0 +1,7 @@ +--- + +apikey: + prefix: + secret: + +...