add flowrs config add documentation

jvanbuel · Nov 16, 2024 · c3e680c · c3e680c
1 parent c0d3082
commit c3e680c
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -3,6 +3,7 @@
 
 build:
 	cargo build --release && cp target/release/flowrs .
+	cp flowrs /usr/local/bin/flowrs
 
 
 logo:

diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ cargo install --path .
 
 You can register an Airflow server instance with the `flowrs config add` command:
 
+![flowrs config add demo](./vhs/add_config.gif)
 
 
 This creates an entry in a `~/.flowrs` configuration file. If you have multiple Airflow servers configured, you can easily switch between them in `flowrs` starting screen.

diff --git a/vhs/add_config.gif b/vhs/add_config.gif
diff --git a/vhs/add_config.tape b/vhs/add_config.tape
@@ -0,0 +1,27 @@
+Set Theme "Dark+"
+Require flowrs
+Set Height 400 
+
+Sleep 1s
+Type "flowrs config add"
+Enter
+Sleep 1s
+Type "airflow-test"
+Enter
+Sleep 1s
+Type "https://localhost:8080"
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Type "airflow"
+Sleep 1s
+Enter
+Type "airflow"
+Sleep 1s
+Enter
+Type "airflow"
+Sleep 500ms
+Enter
+Sleep 2s
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ @@
     build:
     	cargo build --release && cp target/release/flowrs .
+    	cp flowrs /usr/local/bin/flowrs
     logo:
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,6 +24,7 @@ cargo install --path .

		You can register an Airflow server instance with the `flowrs config add` command:

		![flowrs config add demo](./vhs/add_config.gif)


		This creates an entry in a `~/.flowrs` configuration file. If you have multiple Airflow servers configured, you can easily switch between them in `flowrs` starting screen.
Expand Down