Skip to content

Commit 046b020

Browse files
authored
Update README.md
Reorganize and rewrite
1 parent cb85190 commit 046b020

File tree

1 file changed

+66
-16
lines changed

1 file changed

+66
-16
lines changed

README.md

Lines changed: 66 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,83 @@
1-
# Obsidian Starter Vault
1+
# Obsidian Starter
22

33
A clean, minimalist Obsidian vault template for distraction-free note-taking and knowledge management.
44

5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
7+
## Philosophy
8+
9+
This starter vault embraces the idea that the best knowledge systems grow organically from your own thinking patterns. Rather than adopting someone else’s complex system, start with this minimal foundation and build exactly what you need.
10+
11+
Don’t start with other people’s clutter and cruft.
12+
513
## Features
614

7-
- **Minimal**: No plugins, themes, or configurations that get in your way
8-
- **Clean**: Start with a blank slate, not someone else's organization system
9-
- **Flexible**: Perfect for both beginners and advanced Obsidian users
10-
- **Intentional**: Designed after extensive Obsidian experience
15+
- Minimal: No plugins, themes, or configurations that get in your way
16+
- Clean: Start with a blank slate, not someone elses organization system
17+
- Flexible: Perfect for both beginners and advanced Obsidian users
18+
- Intentional: Designed after extensive Obsidian experience
1119

12-
## Getting Started
20+
## What’s Included
1321

14-
1. Click the ["Use this template"](https://github.com/philoserf/obsidian-starter/generate) button
15-
2. Clone your new repository
16-
3. Open the folder as an Obsidian vault
17-
4. Start creating your notes without distractions
22+
This template provides:
1823

19-
## Philosophy
24+
- MIT License file
25+
- This README (remove it after setup)
26+
27+
What’s NOT included:
28+
29+
- No community plugins
30+
- No custom themes
31+
- No pre-defined folder structure
32+
- No sample notes or templates
33+
34+
## Prerequisites
35+
36+
- [Obsidian](https://obsidian.md/) installed on your device
37+
- GitHub account (for using the template)
38+
- Git (optional, for cloning)
2039

21-
This starter vault embraces the idea that the best knowledge systems grow organically from your own thinking patterns. Rather than adopting someone else's complex system, start with this minimal foundation and build exactly what you need.
40+
## Quick Start
41+
42+
1. Click the [“Use this template”](https://github.com/philoserf/obsidian-starter/generate) button
43+
1. Name your new repository
44+
1. Clone your repository or download as ZIP
45+
1. Open the folder as an Obsidian vault:
46+
- Launch Obsidian
47+
- Click “Open folder as vault”
48+
- Select your cloned/downloaded folder
49+
1. Start creating your first note
50+
51+
## Next Steps
52+
53+
After setup, consider:
54+
55+
- Creating your first daily note
56+
- Exploring Settings → Options to customize appearance and behavior
57+
- Adding community plugins only when you identify a specific need
58+
- Developing your own folder structure as your notes accumulate
2259

2360
## Compatibility
2461

25-
Works with Obsidian and has been tested with Visual Studio Code + Foam plugin.
62+
- Works with Obsidian (tested with latest versions)
63+
- Compatible with Visual Studio Code + Foam plugin
64+
- Supports desktop and mobile Obsidian apps
65+
66+
## Documentation
67+
68+
Visit the [project site](https://philoserf.github.io/obsidian-starter/) for additional information.
69+
70+
## Contributing
71+
72+
Issues and suggestions welcome. Open an issue to discuss changes or report problems.
2673

2774
## License
2875

29-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
76+
This project is licensed under the MIT License - see the <LICENSE> file for details.
77+
78+
## Cleanup
3079

31-
---
80+
After creating your vault from this template, you can safely remove:
3281

33-
**Tip**: After creating your own repository from this template, you can safely remove the README.md and LICENSE files.
82+
- This README.md file
83+
- The LICENSE file (or keep it if redistributing)

0 commit comments

Comments
 (0)