create-vault-cms 1.0.8 → 1.0.9

package/README.md

@@ -1,42 +1,37 @@
 # Vault CMS
 
-Use [Obsidian](https://obsidian.md) as a content management system for your [Astro](https://astro.build) website.
+The open-source headless content management system that turns [Obsidian](https://obsidian.md) into a publishing platform for your [Astro](https://astro.build) website.
 
 ![Vault CMS cover with Obsidian and Astro logos at the bottom.](https://github.com/user-attachments/assets/fb5d8368-71dd-4bf8-8851-36ada6d4f530)
 
+## Features 
+
+- **Auto-detection and automation**: Understands your content structure and lets you focus on writing.
+- **CMS-like homepage**: See your content in a visual grid and perform bulk actions.
+- **Preconfigured**: Optimized settings, hotkeys, and plugins for the Astro workflow.
+- **Headless and flexible**: Just Markdown files and a workspace ready to be customized by you.
+- **Compatability**: Works with almost any Astro theme.
+
 ## Quick Start
 
-The fastest way to install Vault CMS into your Astro project is via the CLI:
+The fastest way to install Vault CMS into your Astro project is via the CLI at your project root:
 
 ```bash
 pnpm create vault-cms
 ```
 
-*Follow the prompts to install into `src/content` or your desired directory.*
+*Follow the prompts to install into `src/content` or your desired sub-directory.*
 
-## Documentation
+### Manual Installation
 
-For full installation guides, plugin details, and customization options, read the [Vault CMS documentation](https://docs.vaultcms.org).
+If you prefer to install manually, you can download the latest version of Vault CMS and place it directly into your Astro project.
 
-## Features 
+1. **Download the source**: [Clone this repository](https://github.com/davidvkimball/vault-cms) or [download the ZIP archive](https://github.com/davidvkimball/vault-cms/archive/refs/heads/master.zip).
+2. **Locate your content directory**: In most Astro projects, this is `src/content`.
+3. **Move the files**: Copy the `.obsidian` and `_bases` folders (and `_GUIDE.md`) from the Vault CMS source into your content directory.
+4. **Open in Obsidian**: Open the content directory as a new vault in Obsidian.
 
-- Easy integration into Astro website projects
-- **Auto-detection** of your Astro theme and content structure
-- Preconfigured plugins, hotkeys and settings optimized for Astro workflows
-- CMS-like homepage using Obsidian Bases
-- Works with any Astro theme by automatically detecting content types and frontmatter properties
-- Optional instant-publish option via the Git plugin
-
-![Vault CMS Showcase.](https://github.com/user-attachments/assets/0d1ea89e-9d6b-40b1-944d-cfe6143e222e)
-
-## Video Guide
-
-📺 [Video Guide](https://youtu.be/dSm8aLPdVz0)
-
-> [!NOTE]
-> To see Vault CMS combined with an Astro site specifically designed with it in mind, check out my theme [Astro Modular](https://github.com/davidvkimball/astro-modular).
-
-## Presets
+### Presets
 
 If you are using a supported theme like **Starlight**, **Slate**, or **Chiri**, you can use a preconfigured preset:
 
@@ -45,3 +40,14 @@ pnpm create vault-cms -- --template starlight
 ```
 
 See all available presets at the [Presets Repo](https://github.com/davidvkimball/vault-cms-presets).
+
+## Deep Dive
+
+- **Documentation**: [docs.vaultcms.org](https://docs.vaultcms.org)
+- **Video Guide**: [Set Up Guide on YouTube](https://www.youtube.com/watch?v=3zeqJ5tqmaQ)
+- **Community**: [Join the Discord](https://discord.gg/gyrNHAwHK8)
+
+> [!NOTE]
+> To see Vault CMS combined with an Astro site specifically designed with it in mind, check out the [Astro Modular](https://github.com/davidvkimball/astro-modular) theme.
+
+![Vault CMS Showcase.](https://github.com/user-attachments/assets/0d1ea89e-9d6b-40b1-944d-cfe6143e222e)

package/_GUIDE.md

@@ -0,0 +1,26 @@
+# Welcome to Vault CMS
+
+## Run the setup wizard
+
+If you just installed Vault CMS, the most important step is running the wizard. It will detect your Astro theme and configure your content types automatically.
+
+> [!TIP]
+> **Command**: Press `Ctrl/Cmd + P` and search for **"Vault CMS: Open Wizard"** if you closed it.
+
+## The CMS home base
+
+We use a custom Obsidian bases view to give you a bird's-eye view of your content.
+
+> [!NOTE]
+> Click the **Home** icon in your tab bar or open the `_bases/Home.base` file to see your content in a grid view.
+
+## Key workflows
+
+- **Writing**: hust use `Ctrl/Cmd + N` to create a new file using your default content type and start writing.
+- **Publishing**: use the **Git: Push** command (or click the up arrow in the status bar) to send your changes live to your Astro site.
+
+### Need help?
+
+- **Documentation**: [docs.vaultcms.org](https://docs.vaultcms.org)
+- **Community**: [join the Discord](https://discord.gg/gyrNHAwHK8)
+- **Video Guide**: [set up guide on YouTube](https://www.youtube.com/watch?v=3zeqJ5tqmaQ)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vault-cms",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Installer for Vault CMS",
   "main": "src/cli.js",
   "bin": {
@@ -9,6 +9,7 @@
   "files": [
     "src",
     "README.md",
+    "_GUIDE.md",
     "LICENSE"
   ],
   "scripts": {

package/src/cli.js

@@ -97,7 +97,7 @@ program
         throw new Error(`Template "${template}" not found in presets repository.`);
       }
 
-      const toKeep = ['_bases', '.obsidian', 'README.md'];
+      const toKeep = ['_bases', '.obsidian', '_GUIDE.md'];
       for (const item of toKeep) {
         const src = path.join(sourcePath, item);
         const dest = path.join(targetDir, item);