Skip to content

Commit 429a3c2

Browse files
committed
Add more details to README
1 parent f038116 commit 429a3c2

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# Timelive Plugin
22

3-
Plugin for [Obsidian](https://obsidian.md) that turns a list of dates into a
4-
timeline.
3+
Plugin for [Obsidian](https://obsidian.md) that turns a list of dates into a timeline.
54

65
## Usage
76

87
The key difference from other timeline plugins is that Timelive doesn't use a code block. It's much easier to format any date event, provide a link or block of code, add an image or a video, etc.
98

10-
To build a timeline, you need to define a list of dates, enclosed by the `|` symbol. The date format is automatically detected, but in case of ambiguity, the preferred format can be selected in the preferences.
9+
To build a timeline, you need to define a list of dates, enclosed by the `|` symbol. The date format is automatically detected, but in case of ambiguity, the preferred format can be selected in the preferences. You can also generate a placeholder with the **Timelive: New block** action (accessible from <kbd>Ctrl+P</kbd> Command Palette).
1110

1211
There is also support for time spans. Just define two dates separated by ` - ` and they will be turned into a span.
1312

13+
The timeline will be rendered in Reading view, or in Live Editing mode in case you embed a note with a timeline.
14+
1415
````
1516
## Demo
1617
- |2011-02-05| Start
@@ -35,8 +36,7 @@ There is also support for time spans. Just define two dates separated by ` - ` a
3536
- |2056-05-24| Some future event
3637
````
3738

38-
Use `now`, `today` or `present` to indicate that the project is live and that
39-
today's marker should be added.
39+
Use `now`, `today` or `present` to indicate that the project is live and that today's marker should be added.
4040

4141
![preview](https://github.com/aNNiMON/obsidian-timelive/blob/images/preview.png?raw=true)
4242

info.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@
99
- |2025-03-02| Switched to Deno, added an editor command
1010
- |2025-03-28 - 2025-04-06| Implementing time spans
1111
- |2025-06-11| Operate DOM element tree better way
12+
- |2025-06-13| Plugin included in the Community plugins list 🎉
1213
- |present| Developing the `Timelive` plugin

0 commit comments

Comments
 (0)