Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kvankova committed Nov 3, 2024
1 parent 69cbba4 commit fd3cc64
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## **Code Embedder**
Seamlessly update code snippets in your **README** files! 🔄📝🚀

[Description](#-description)[How it works](#-how-it-works)[Examples](#-examples)[Setup](#-setup)[Under the hood](#-under-the-hood)
[Description](#-description)[How it works](#-how-it-works)[Setup](#-setup)[Examples](#-examples)[Under the hood](#-under-the-hood)
</div>


Expand Down Expand Up @@ -59,6 +59,31 @@ In the `README` (or other markdown) file, the object of the script is marked wit
> [!Note]
> If there is a section with the same name as any object, the object definition will be used in the `README` instead of the section. To avoid this, **use unique names for sections and objects!**
## 🔧 Setup
To use this action, you need to configure a yaml workflow file in `.github/workflows` folder (e.g. `.github/workflows/code-embedder.yaml`) with the following content:

```yaml
name: Code Embedder

on: pull_request

permissions:
contents: write

jobs:
code_embedder:
name: "Code embedder"
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Run code embedder
uses: kvankova/code-embedder@v0.4.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## 💡 Examples

Expand Down Expand Up @@ -183,31 +208,6 @@ class Person:

With any changes to the function `print_hello` or class `Person` in `main.py`, the code block sections are updated in the `README` file with the next workflow run.

## 🔧 Setup
To use this action, you need to configure a yaml workflow file in `.github/workflows` folder (e.g. `.github/workflows/code-embedder.yaml`) with the following content:

```yaml
name: Code Embedder

on: pull_request

permissions:
contents: write

jobs:
code_embedder:
name: "Code embedder"
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Run code embedder
uses: kvankova/code-embedder@v0.4.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## 🔬 Under the hood
This action performs the following steps:
Expand Down

0 comments on commit fd3cc64

Please sign in to comment.