added examples

contributte · Dec 5, 2021 · ffe5f0f · ffe5f0f
1 parent 871a8d1
commit ffe5f0f
Show file tree

Hide file tree

Showing 17 changed files with 930 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
 /vendor
-composer.lock
+/composer.lock
diff --git a/examples/.gitignore b/examples/.gitignore
@@ -0,0 +1 @@
+vendor
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,27 @@
+# Anabelle Demo
+
+See [DEMO](https://examples.contributte.org/packages/anabelle/).
+
+## Installation
+
+```bash
+composer install
+```
+
+## Generating API Documentation
+
+```bash
+composer generateDocs
+```
+
+or
+
+```bash
+vendor/bin/anabelle docs-src docs --overwriteOutputDir
+```
+
+## View documentation
+
+```bash
+php -S localhost:8000 -t docs
+```
diff --git a/examples/composer.json b/examples/composer.json
@@ -0,0 +1,8 @@
+{
+  "require": {
+    "contributte/anabelle": "^3.0"
+  },
+  "scripts": {
+    "generateDocs": "vendor/bin/anabelle docs-src docs --overwriteOutputDir"
+  }
+}