From e8cee35821a63712fd6060dbe7370ad6633859d3 Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Thu, 3 Jun 2021 17:23:38 -0400 Subject: [PATCH] docs: update readme --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c7d3254..d87683d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -# Obsidian Starter Kit +# Ben's Obsidian Boilerplate -An opinionated starter kit to help people get up and running as quickly as possible. +An opinionated boilerplate for people using [Obsidian](https://obsidian.md/). + +If you're new to Obsidian, I'd recommend just using it without any plugins or configs. Just get familiar with the interface as a Markdown editor and linking things. + +Once you're more acclimated to it, then feel free to take pieces of inspiration from the boilerplate! ## 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 +2. [Download](https://github.com/bencodezen/bens-obsidian-boilerplate/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