Skip to content

Commit d5c42a5

Browse files
authored
Update README.md
1 parent 18515b9 commit d5c42a5

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,22 @@ Unlike plain Markdown, `mdbub` lets you *structure* your ideas—navigate, fold,
3030
mdbub tech_idea.mdbub
3131
```
3232

33-
Create nodes like this:
33+
It looks like this:
3434

3535
```
3636
【AI-Driven Co...】 > 【Core Concept】 > 【Voice Intera...】
3737
● Voice Interaction should be two-way
3838
└─ No children
39-
4039
```
40+
Just start typing to edit the label on a node; or hit **enter** to add a sibling; or hit **tab** to add a child.
4141

42-
Comeback later directly to the node you were working on using a deeplink like this:
43-
44-
```bash
45-
mdbub tech_idea.mdbub#design/api
46-
```
42+
If you add an id in the text, like this: `[id:design/api]`, you can comeback later directly to that node with a deeplink: `mdbub tech_idea.mdbub#design/api`
4743

4844
While you work:
49-
- Add inlint #tags to make them easier to find or filter.
50-
- Add inline @key:value maps to track metadata of nodes
51-
45+
- Add inlint `#tags` to make them easier to find or filter
46+
- Add inline `@key:value` maps to track metadata of nodes
47+
- Add inline `[id:something]` ids to later link
48+
5249
## 🛠 Installation
5350

5451
### Quick Install (coming soon)
@@ -70,7 +67,7 @@ While we work on getting into the main package repositories, you can install via
7067

7168
```bash
7269
# Development version
73-
pip install git+https://github.com/YOUR_USERNAME/mdbubbles.git
70+
pip install git+https://github.com/collabinator/mdbubbles.git
7471
```
7572
---
7673

0 commit comments

Comments
 (0)