Skip to content

Commit

Permalink
Update README.md (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
April-Gras committed Jul 7, 2023
1 parent d007615 commit df7ddc7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ A theme agnostic timeline generator for [obsidian](https://obsidian.md/)

This plugins allows you to tag notes to generate timelines. It's designed with story telling in mind.

## Sample vault with basic examples
[TimelineSampleVault.zip](https://github.com/April-Gras/obsidian-auto-timelines/files/11983177/TimelineSampleVault.zip)

Here's a zip file of a obsidian vault with various basic examples to help you build timelines.
Alternatively [Josh Plunkett](https://www.youtube.com/@JoshPlunkett) did [a tutorial video](https://www.youtube.com/watch?v=992o1j8zRSk) covering the basics

### How to use

Start by adding some metadata to the notes that you want to appear in your timeline.
Expand Down Expand Up @@ -125,9 +131,3 @@ Before launching the unit tests, make sure to install the dependencies with `npm

Once that's out of the way use `npm run test` to just launch the tests.
`npm run test-ui` to run the UI and see coverage in your browser.

## Sample vault with basic examples
[TimelineSampleVault.zip](https://github.com/April-Gras/obsidian-auto-timelines/files/11790506/TimelineSampleVault.zip)

Here's a zip file of a obsidian vault with various basic examples to help you build timelines.
Alternatively [Josh Plunkett](https://www.youtube.com/@JoshPlunkett) did [a tutorial video](https://www.youtube.com/watch?v=992o1j8zRSk) covering the basics

0 comments on commit df7ddc7

Please sign in to comment.