Octoprint service (#324) (#560)

[github/bastienwirtz/homer.git] / dummy-data / README.md

diff --git a/dummy-data/README.md b/dummy-data/README.md
index deed87557d735c70f62c36d0c203b015c1f62ef8..78b2243608b8a6af0ba62cd72403541f2e80c361 100644 (file)
--- a/dummy-data/README.md
+++ b/dummy-data/README.md
@@ -1,15 +1,22 @@
 # 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: 
+## Start the mock server to expose dummy data
 
-- create a directory for your service, and any sub-folder existing in the service api path. 
+```sh
+yarn mock
+```
+
+## How to add a new services sample
+
+- 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-pihile.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)
+```