From d576ad812d1acb58a8cc70a296f38d8bc746a5d7 Mon Sep 17 00:00:00 2001 From: Mitchell Bifeld Date: Wed, 1 May 2024 13:10:05 -0700 Subject: [PATCH] Move content location --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f413b4bf..7541e898 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ Execute: Reads the document and executes all of the code blocks not pausing for input or testing output. Essentially executes a markdown file as a script. `ie execute tutorial.md` +## Use Innovation Engine with any URL + +Documentation does not need to be stored locally in order to run IE with it. With v0.1.3 and greater, you can run `ie execute`, `ie interactive`, and `ie test` with any URL that points to a public markdown file, including raw GitHub URLs. See the below demo: + +https://github.com/Azure/InnovationEngine/assets/55719566/ce37f53c-9876-42b9-a033-1e4acaeb9d50 + ## Use Executable documentation for Automated Testing One of the core benefits of executable documentation is the ability to run automated testing on markdown file. This can be used to ensure freshness of @@ -176,12 +182,6 @@ As it is written the code will pause and wait for input on any header or code block. Any document written in standard markdown can be run as an interactive document. -## Use Innovation Engine with any URL - -Documentation does not need to be stored locally in order to run IE with it. With v0.1.3 and greater, you can run `ie execute`, `ie interactive`, and `ie test` with any URL that points to a public markdown file, including raw GitHub URLs. See the below demo: - -https://github.com/Azure/InnovationEngine/assets/55719566/ce37f53c-9876-42b9-a033-1e4acaeb9d50 - ## Contributing This is an open source project. Don't keep your code improvements,