docs: add examples

example/example.md

@@ -0,0 +1,4 @@
+# Config examples
+
+- [Example for config as pubspec.yaml](pubspec.example.yaml)
+- [Example for config as script_runner.yaml](script_runner.example.yaml)

example/pubspec.example.yaml

@@ -0,0 +1,12 @@
+# add a config to your pubspec.yaml
+script_runner:
+  shell: /bin/zsh
+  scripts:
+    - test: dart test
+    - lint-fix: dart fix --apply
+    - name: build:apk
+      cmd: flutter build apk
+    - name: build:ipa
+      cmd: flutter build ipa
+    - name: build:all
+      cmd: build:apk && build:ipa

example/script_runner.example.yaml

@@ -0,0 +1,12 @@
+# add a config in the script_runner.yaml
+# note! there is no `script_runner` key at the root here:
+shell: /bin/zsh
+scripts:
+  - test: dart test
+  - lint-fix: dart fix --apply
+  - name: build:apk
+    cmd: flutter build apk
+  - name: build:ipa
+    cmd: flutter build ipa
+  - name: build:all
+    cmd: build:apk && build:ipa