diff --git a/README.md b/README.md index 107f203..5879996 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ -# obsidian-starter-kit (version alpha-0.1.0) +# Obsidian Starter Kit -An opinionated starter kit to help people get up and running as quickly as possible +An opinionated starter kit to help people get up and running as quickly as possible. + +## Getting Up and Running + +1. Download and install [Obsidian](https://obsidian.md/) +2. [Download](https://github.com/bencodezen/obsidian-starter-kit/archive/refs/heads/main.zip) or clone a fork of this repo +3. Open Obsidian and you should see a prompt like below: + +Obsidian open prompt + +4. Click on the `Open` button next to "Open folder as vault" +5. Select the folder you've downloaded / cloned from Step #2. diff --git a/assets/obsidian-prompt.png b/assets/obsidian-prompt.png new file mode 100644 index 0000000..4294e57 Binary files /dev/null and b/assets/obsidian-prompt.png differ