Skip to content

Commit 3a98610

Browse files
committed
docs: Add TL;DR section to README.md
Includes a concise summary at the beginning of the README to quickly explain the plugin's purpose and key aspects for new visitors. Also updates the Table of Contents.
1 parent 4ba99ed commit 3a98610

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,20 @@ Yes, you read that right! With this plugin, you can **develop plugins for Obsidi
1111
> Ever needed to build plugins for Obsidian but felt like JavaScript wasn't your cup of tea?
1212
> With **Obsidian Python Bridge**, you can now use your favorite language, **Python**, to create plugins for Obsidian. 🙌
1313
14+
<a id="tldr"></a>
15+
## TL;DR (Too Long; Didn't Read)
16+
17+
* **What is this?** An Obsidian plugin that lets you run Python scripts to interact with your vault.
18+
* **Why?** Makes extending Obsidian accessible if you prefer Python over JavaScript/TypeScript, especially for automation and data processing.
19+
* **How?** The plugin runs your `.py` scripts. A companion Python library (`ObsidianPluginDevPythonToJS.py`) makes it easy to call Obsidian functions (get/modify notes, show notifications, use modals, etc.) from your script via a local HTTP connection.
20+
* **Cool Features:** Cross-platform (Win/Mac/Linux), define UI settings for your scripts within Obsidian, trigger scripts from events, full vault access API, and more.
21+
* **Basically:** Write Python, control Obsidian.
22+
1423
---
1524

1625
**Table of Contents**
1726

27+
- [TL;DR](#tldr)
1828
- [Description](#description)
1929
- [Key Features](#key-features)
2030
- [🌍 Internationalization](#internationalization)

0 commit comments

Comments
 (0)