Skip to content

Commit

Permalink
Move content location
Browse files Browse the repository at this point in the history
  • Loading branch information
mbifeld committed May 1, 2024
1 parent b6b7c46 commit f3124bd
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit f3124bd

Please sign in to comment.