]> git.immae.eu Git - github/bastienwirtz/homer.git/blobdiff - dummy-data/README.md
qBittorrent service (#540)
[github/bastienwirtz/homer.git] / dummy-data / README.md
index eeff4ecb458de5a2fd05af33dd9e58553432a06e..6db4712edcb2abecd7b353f02bf05ad10c5a08eb 100644 (file)
@@ -1,15 +1,16 @@
 # Dummy data
 
-This directory content makes possible to test custom services cards or create a demo without actually running the service. 
+This directory content makes possible to test custom services cards or create a demo without actually running the service.
 The principle is simple: save a sample output of the API used in the service in a static file in this directory. The path must be identical as the service endpoint to be used seamlessly.
 
-## How to add a new services sample
+## How to add a new services sample
 
-- create a directory for your service, and any sub-folder existing in the service api path. 
+- create a directory for your service, and any sub-folder existing in the service api path.
 - save the api output in a file named after the service endpoint.
 
 Example:
-```
+
+```sh
 mkdir pihole
-curl http://my-pihole.me/admin/api.php -o pihole/api.php # /admin is omited because for PiHole, the implementation expect it to be in the base url (`url` or `enpoint` property)
-```
\ No newline at end of file
+curl http://my-pihole.me/admin/api.php -o pihole/api.php # /admin is omited because for PiHole, the implementation expect it to be in the base url (`url` or `endpoint` property)
+```