chill/bens-obsidian-boilerplate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Ben Hong
2021-06-03 17:23:38 -04:00
parent a4f323b704
commit e8cee35821
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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:
<img src="/assets/obsidian-prompt.png" alt="Obsidian open prompt" width="300" />