Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pPrecel committed Mar 16, 2024
1 parent aa20fd4 commit 1babfff
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions examples/simple-flow/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# Simple Flow

This scenario shows how to generate `.diff` files for a few repositories for the actual PKUP period in the acctual directory.
This scenario shows how to generate `.diff` files for a few repositories for the actual PKUP period in the actual directory.

1. Construct `pkup-gen` spell with most basic flags:
1. Construct the `pkup-gen` spell with the most basic flags:

```bash
pkup gen --username "<GITHUB_USERNAME>" --repo "<ORG>/<REPO>"
```

> Example: pkup gen --username "pPrecel" --repo "kyma-project/serverless-manager"

2. Because PAT token is not provided, `pkup-gen` try to connect to the GitHub app to create one - here follow the instructions in the `WARN` log:

![1](../../assets/screenshot-simple-flow-1.png)

3. On GitHub side you have to pass copied code and click `Continue` and then `Authorize pkup-gen`:
2. Because PAT is not provided, `pkup-gen` tries to connect to the GitHub app to create one - here follow the instructions in the `WARN` log:

![1]On the GitHub side you have to pass the copied code, click `Continue` and then `Authorize pkup-gen`:
![2](../../assets/screenshot-simple-flow-2.png)
![3](../../assets/screenshot-simple-flow-3.png)

4. Now `pkup-gen` continues to generate artifacts what is represented in logs:
3. Now `pkup-gen` continues to generate artifacts that are represented in logs:

![4](../../assets/screenshot-simple-flow-4.png)

5. At the end you can see a few new files generated in the acctual directory and the `.txt` file with all info to manually fill `.docx` report:
4. At the end you can see a few new files generated in the actual directory and the `.txt` file with all the info to manually fill the `.docx` report:

![5](../../assets/screenshot-simple-flow-5.png)
![6](../../assets/screenshot-simple-flow-6.png)

0 comments on commit 1babfff

Please sign in to comment.