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 b005569 commit 4d7f7bb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Seamlessly update code snippets in your **README** files! πŸ”„πŸ“πŸš€
### ✨ Key features
- πŸ”„ **Automatic synchronization**: Keep your `README` code examples up-to-date without manual intervention.
- πŸ› οΈ **Easy setup**: Simply add the action to your GitHub workflow and format your `README` code blocks.
- πŸ“ **Section support**: Update specific sections of the script in the `README`.
- 🧩 **Object support**: Update specific objects (functions, classes) in the `README`. *The latest version supports only 🐍 Python objects (other languages to be added soon).*
- πŸ“ **Section support**: Update only specific sections of the script in the `README`.
- 🧩 **Object support**: Update only specific objects (functions, classes) in the `README`. *The latest version supports only 🐍 Python objects (other languages to be added soon).*


By using **Code Embedder**, you can focus on writing and updating your actual code πŸ’», while letting the action take care of keeping your documentation current πŸ“šπŸ”„. This reduces the risk of outdated or incorrect code examples in your project documentation.
Expand Down Expand Up @@ -57,7 +57,7 @@ In the `README` (or other markdown) file, the object of the script is marked wit
> The object name must match exactly the name of the object (function, class) in the script file. Currently, only 🐍 Python objects are supported.
> [!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!
> 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!**

## πŸ’‘ Examples
Expand Down

0 comments on commit 4d7f7bb

Please sign in to comment.