Skip to content

Commit 4d7f7bb

Browse files
committed
docs: Update README
1 parent b005569 commit 4d7f7bb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Seamlessly update code snippets in your **README** files! 🔄📝🚀
1616
### ✨ Key features
1717
- 🔄 **Automatic synchronization**: Keep your `README` code examples up-to-date without manual intervention.
1818
- 🛠️ **Easy setup**: Simply add the action to your GitHub workflow and format your `README` code blocks.
19-
- 📝 **Section support**: Update specific sections of the script in the `README`.
20-
- 🧩 **Object support**: Update specific objects (functions, classes) in the `README`. *The latest version supports only 🐍 Python objects (other languages to be added soon).*
19+
- 📝 **Section support**: Update only specific sections of the script in the `README`.
20+
- 🧩 **Object support**: Update only specific objects (functions, classes) in the `README`. *The latest version supports only 🐍 Python objects (other languages to be added soon).*
2121

2222

2323
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.
@@ -57,7 +57,7 @@ In the `README` (or other markdown) file, the object of the script is marked wit
5757
> The object name must match exactly the name of the object (function, class) in the script file. Currently, only 🐍 Python objects are supported.
5858
5959
> [!Note]
60-
> 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!
60+
> 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!**
6161
6262

6363
## 💡 Examples

0 commit comments

Comments
 (0)