From c2a2fe4833ebbd91b66fb6a79ad5250c912ff897 Mon Sep 17 00:00:00 2001 From: beastoin Date: Wed, 11 Oct 2023 15:45:59 +0700 Subject: [PATCH] v0.2.8 --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ea92ac7..4f15232 100644 --- a/README.md +++ b/README.md @@ -44,23 +44,30 @@ RFSH works by 3 simple steps: [![RFSH Sample - HN APIs test](https://raw.githubusercontent.com/docsion/rfsh/main/sample/hn/Screenshot%202023-10-10%20at%2017.32.21.png)](https://github.com/docsion/rfsh/blob/main/sample/built-in) ### Basic -Run the following script to execute the basic job sample. You can find the script, input data, template at [sample](https://github.com/docsion/rfsh/tree/main/sample): + ``` +runflow basic -i https://github.com/docsion/rfsh/blob/main/sample/sample.csv -t https://github.com/docsion/rfsh/blob/main/sample/sample.template +``` + +Or run the following stand-alone job script. ``` curl https://raw.githubusercontent.com/docsion/rfsh/main/sample/30969f5a-6369-11ee-a32e-f297ad799bdb.sh | sh # # |- generated by: -# |- $runflow --generate-job basic -i https://github.com/docsion/rfsh/blob/main/sample/sample.csv -t https://github.com/docsion/rfsh/blob/main/sample/sample.template +# |- $ runflow --generate-job basic -i https://github.com/docsion/rfsh/blob/main/sample/sample.csv -t https://github.com/docsion/rfsh/blob/main/sample/sample.template ``` +You can find the script, input data, template at [sample](https://github.com/docsion/rfsh/tree/main/sample): + ### Hackernews APIs Test -You can find the script, input data, template at [sample/hn](https://github.com/docsion/rfsh/tree/main/sample/hn): ``` curl https://raw.githubusercontent.com/docsion/rfsh/main/sample/hn/827c2d38-6695-11ee-9663-f297ad799bdb.sh | sh # # |- generated by: -# |- $runflow --generate-job basic -i https://github.com/docsion/rfsh/blob/main/sample/hn/items.csv -t https://github.com/docsion/rfsh/blob/main/sample/hn/item.template.sh --test-template https://github.com/docsion/rfsh/blob/main/sample/hn/item.test.template.sh +# |- $ runflow --generate-job basic -i https://github.com/docsion/rfsh/blob/main/sample/hn/items.csv -t https://github.com/docsion/rfsh/blob/main/sample/hn/item.template.sh --test-template https://github.com/docsion/rfsh/blob/main/sample/hn/item.test.template.sh ``` +You can find the script, input data, template at [sample/hn](https://github.com/docsion/rfsh/tree/main/sample/hn): + ## Install Run the following install script to install the latest version of RFSH: ``` @@ -142,7 +149,7 @@ Run the following job script to explore how it works: curl https://raw.githubusercontent.com/docsion/rfsh/main/sample/30969f5a-6369-11ee-a32e-f297ad799bdb.sh | sh # # |- generated by: -# |- $runflow --generate-job basic -i sample/sample.csv -t sample/sample.template --test-template sample/sample.test.template --export-template sample/sample.export.template +# |- $ runflow --generate-job basic -i sample/sample.csv -t sample/sample.template --test-template sample/sample.test.template --export-template sample/sample.export.template ``` You can find sample test at [sample/sample.test.template](https://github.com/docsion/rfsh/blob/main/sample/sample.test.template): @@ -205,7 +212,7 @@ You can find the --auth-phrase [here](auth_phrase.txt) for the period running fl ## Github You can import an input or a template file from Github repository. Note that if you use private repository, please set `GITHUB_TOKEN` environment variable before running $runflow command. For example: ``` -GITHUB_TOKEN= runflow basic -i https://github.com/my/privaterepo/blob/main/sample/sample.csv -t https://github.com/docsion/rfsh/blob/main/sample/sample.template +$ GITHUB_TOKEN= runflow basic -i https://github.com/my/privaterepo/blob/main/sample/sample.csv -t https://github.com/docsion/rfsh/blob/main/sample/sample.template ``` You can find Github guideline [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) to generate new token.