Skip to content

Commit

Permalink
update readme (installer version issue)
Browse files Browse the repository at this point in the history
  • Loading branch information
woosukji committed Oct 29, 2024
1 parent 2399547 commit a5a4e42
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@ Note: The Apply Edit feature is currently slower than desired. We are working on

## Getting Started

> **⚠️ Important: Installer Version Requirement**
> Smart Composer requires a recent version of the Obsidian installer. If you experience issues with the plugin not loading properly:
>
> 1. First, try updating Obsidian normally at `Settings > General > Check for updates`.
>
> 2. If issues persist, manually update your Obsidian installer:
> - Download the latest installer from [Obsidian's download page](https://obsidian.md/download)
> - Close Obsidian completely
> - Run the new installer
>
> For more details, see [Obsidian's guide on installer updates](https://help.obsidian.md/Getting+started/Update+Obsidian#Installer+updates).
Currently, Smart Composer is available through [Beta Quickstart](#beta-quickstart-recommended) or [Manual Installation](#manual-installation). Community plugin support is coming soon.

### Beta Quickstart (Recommended)
Expand Down Expand Up @@ -93,10 +105,6 @@ Smart Composer adds a few commands to work with AI. You can set custom hotkeys f
3. Place the downloaded files into this new folder.
4. Open Obsidian settings `Settings > Community plugins`, and enable Smart Composer.

### Troubleshooting

Smart Composer requires a recent version of the Obsidian installer. If you experience installation issues, please ensure your Obsidian is updated to the latest version. To check your Obsidian version, navigate to `Settings > General > Check for updates`.

## Roadmap

To see our up-to-date project roadmap and progress, please check out our [GitHub Projects kanban board](https://github.com/glowingjade/obsidian-smart-composer/projects?query=is%3Aopen).
Expand Down

0 comments on commit a5a4e42

Please sign in to comment.