create-vault-cms 1.0.0 → 1.0.1

package/README.md

@@ -25,48 +25,49 @@ Use [Obsidian](https://obsidian.md) as a content management system for your [Ast
 
 ## Installation Guide
 
-1. Clone or install your Astro theme of choice.
-2. Clone or download a zip of this repo.
-3. Copy the contents of the `Starter Vault` folder into your Astro project. **Recommended location:** `src/content` folder, but it can be placed at the level of `src/content` or higher (like the project root).
-4. Open Obsidian and select the "Open folder as vault" option, and select the folder containing the `.obsidian` directory.
-5. The Vault CMS plugin will automatically detect your Astro project structure and guide you through setup via a wizard.
+The easiest way to install Vault CMS is via the CLI:
 
-### Starter Vault vs Theme Examples
+```bash
+# Using pnpm
+pnpm create vault-cms
 
-- **`Starter Vault`**: This is the adaptive vault that works with any Astro theme. It automatically detects your theme's structure and configures itself accordingly. This is what you should copy into your project.
+# Using npm
+npm create vault-cms
 
-- **`Theme Examples`**: This folder contains preconfigured vault examples for specific Astro themes (Slate, Chiri, Starlight). These serve as reference examples showing how Vault CMS can be configured for particular themes. You don't need to use these unless you want to see theme-specific configurations.
-
-### Using Theme Examples
+# Using yarn
+yarn create vault-cms
+```
 
-If you're using one of the supported themes (Slate, Chiri, or Starlight) and want to use a preconfigured vault example instead of the adaptive Starter Vault:
+This will automatically:
+1. Copy the necessary `_bases` and `.obsidian` configuration folders.
+2. Setup a `README.md` for your vault.
+3. Update your `.gitignore` with the recommended Obsidian excludes.
 
-1. Navigate to the `Theme Examples` folder and find your theme's folder (e.g., `Slate`, `Chiri`, or `Starlight`).
-2. **Copy the CONTENTS** of that theme folder (not the folder itself) into your Astro project's `src/content` folder.
-   - ⚠️ **Important**: Copy the files and folders inside the theme folder, not the theme folder itself. For example, if using Slate, copy the contents of `Theme Examples/Slate/` (like `_bases/`, `post/`, etc.) into `src/content/`, not the `Slate` folder. (Note: `_bases` is the new standard, but `bases` is still supported for backwards compatibility).
-3. Open Obsidian and select "Open folder as vault", then select your `src/content` folder (or the folder containing the `.obsidian` directory).
-4. The vault should already be preconfigured for your theme.
+### Manual Installation
 
-> [!TIP]
-> If you're unsure which to use, start with the **Starter Vault** - it will automatically adapt to your theme. Use the Theme Examples only if you want to see a preconfigured setup for a specific theme.
+If you prefer to install manually:
+1. Clone or download a zip of this repo.
+2. Copy the `_bases` and `.obsidian` folders into your Astro project (e.g., in `src/content`).
+3. Open Obsidian and select "Open folder as vault", then select the folder containing the `.obsidian` directory.
 
 ## How Auto-Detection Works
 
 Vault CMS automatically detects and configures itself based on your Astro project:
 
-- **Project Detection**: Automatically finds your Astro project by locating `astro.config.mjs`, `astro.config.ts`, or other Astro config files
-- **Content Type Detection**: Scans your content folders (like `posts`, `pages`, `docs`, etc.) and automatically identifies them as content types
-- **Frontmatter Analysis**: Analyzes existing content files to detect frontmatter properties (title, date, description, etc.) and configures the plugin accordingly
-- **Theme Adaptation**: Adapts to your Astro theme's specific quirks and requirements automatically
+- **Project Detection**: Automatically finds your Astro project by locating `astro.config.mjs`, `astro.config.ts`, or other Astro config files.
+- **Content Type Detection**: Scans your content folders (like `posts`, `pages`, `docs`, etc.) and automatically identifies them as content types.
+- **Frontmatter Analysis**: Analyzes existing content files to detect frontmatter properties (title, date, description, etc.) and configures the plugin accordingly.
+- **Theme Adaptation**: Adapts to your Astro theme's specific quirks and requirements automatically.
 
 When you first open the vault, a setup wizard will guide you through the configuration process. The wizard uses the auto-detected information to pre-populate settings, making setup quick and easy. You can always run the wizard again later by using the "Open Setup Wizard" command.
 
 ### Recommended .gitignore
 
-Add the following to your Astro project's `.gitignore` file:
+If you are not using the CLI, add the following to your Astro project's `.gitignore` file:
 ```
-# Obsidian workspace files
-**/.obsidian/workspace.json
-**/.obsidian/workspace-mobile.json
+# Obsidian
+.obsidian/workspace.json
+.obsidian/workspace-mobile.json
+.ref/
 ```
-This prevents conflicts between multiple devices.
+This prevents conflicts between multiple devices and keeps your vault clean.

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "create-vault-cms",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Installer for Vault CMS",
   "main": "src/cli.js",
   "bin": {
-    "create-vault-cms": "src/cli.js"
+    "create-vault-cms": "src/cli.js",
+    "create-vaultcms": "src/cli.js"
   },
   "files": [
     "src",

package/src/cli.js

@@ -10,7 +10,7 @@ const program = new Command();
 program
   .name('create-vault-cms')
   .description('Official installer for Vault CMS')
-  .version('1.0.0');
+  .version('1.0.1');
 
 program
   .argument('[target]', 'target directory', '.')