From 1eebf9d029ac7c488f7bb7da5185d31cd41ec2fe Mon Sep 17 00:00:00 2001 From: Kremilly Date: Tue, 11 Jun 2024 08:13:57 -0300 Subject: [PATCH] docs: add a code example --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f0ef8b..ecf6578 100644 --- a/README.md +++ b/README.md @@ -23,4 +23,28 @@ For more help and document, see our documentation: - [Providers](https://scibun.github.io/ScimonDocs/providers.html) - [Scimon.yml file](https://scibun.github.io/ScimonDocs/scimon.yml-file.html) - [.env file](https://scibun.github.io/ScimonDocs/env-file.html) -- [External Resources Usage](https://scibun.github.io/ScimonDocs/external-resources.html) \ No newline at end of file +- [External Resources Usage](https://scibun.github.io/ScimonDocs/external-resources.html) + +## Example of code and execute + +```monset +path = "downloads/" +open = "https://scibun.com" + +readme = "https://example.com/readme-example.md" +checksum = "https://example.com/scimon.sha256" +checksum.unmatch = "keep" + +downloads { + https://example.com/file1.pdf !ignore + https://example.com/file2.pdf + https://example.com/file3.pdf !ignore + https://example.com/file4.pdf +} +``` + +Run the command: + +```bash +scimon -r scimon.mon +```