Skip to content

Commit

Permalink
v0.2.8
Browse files Browse the repository at this point in the history
  • Loading branch information
beastoin authored Oct 11, 2023
1 parent b416f5c commit c2a2fe4
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
Expand Down Expand Up @@ -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):
Expand Down Expand Up @@ -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=<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=<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.
Expand Down

0 comments on commit c2a2fe4

Please sign in to comment.