aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLibravatar Alexander Foremny <aforemny@posteo.de>2024-10-11 14:17:33 +0200
committerLibravatar Alexander Foremny <aforemny@posteo.de>2024-10-11 14:17:33 +0200
commit35bf45a81da20d782a8a654703eca14543e25def (patch)
tree920d7d884786b900ba194d1433bc010b94f4e46c /docs
parent939cc3e115f5f7b06b09b46c4519502027e25d0d (diff)
add CLI draft
Diffstat (limited to 'docs')
-rw-r--r--docs/get-started-cli.md22
-rw-r--r--docs/get-started.md4
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/get-started-cli.md b/docs/get-started-cli.md
new file mode 100644
index 0000000..d78a9a5
--- /dev/null
+++ b/docs/get-started-cli.md
@@ -0,0 +1,22 @@
+# Get started with the CLI
+
+## Create a new project
+
+Create a new folder for your project, `my-project`. Change into it, and set `AMCS_CONTENT` to the folder that should store your content.
+
+```
+mkdir -p my-project
+cd my-project
+export ACMS_CONTENT=$PWD/content
+```
+
+## Create a restaurant collection
+
+```
+acms collection insert restaurant/1.json <<'EOF'
+{
+ "name": "Biscotte Restaurant",
+ "description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers."
+}
+EOF
+```
diff --git a/docs/get-started.md b/docs/get-started.md
new file mode 100644
index 0000000..af435b3
--- /dev/null
+++ b/docs/get-started.md
@@ -0,0 +1,4 @@
+# Get started
+
+- [Get started with the CLI](./get-started-cli.md)
+- [Get started with the web interface](./get-started-web-interface.md)