Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #48

Merged
merged 6 commits into from
Oct 28, 2024
Merged

Update README.md #48

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9fc3725
Update Roadmap section
kevin-on Oct 26, 2024
9b8bf58
Update README.md
kevin-on Oct 27, 2024
cae1aa6
Merge branch 'main' into kevin/update-readme
kevin-on Oct 28, 2024
91e1b58
Notice to update obsidian installer version
kevin-on Oct 28, 2024
df4bdfc
Update README
kevin-on Oct 28, 2024
5ad96b8
Ignore markdown files in lint check
kevin-on Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 11 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,27 +93,20 @@ 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.

## Roadmap

#### Expanded Context Support

- [x] Folder context mentioning, and auto context selection (RAG)
- [x] Web content browsing
- [ ] PDF, DOCX, and image understanding
- [ ] Mention Obsidian tag
### Troubleshooting

#### Advanced Search
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`.

- [x] Chat with AI to find specific notes or content

#### Prompt Presets
## Roadmap

- [ ] Save and reuse custom prompts for common tasks
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).

#### Tab Completion
Some of our planned features include:

- [ ] Copilot-like autocomplete
- [ ] Context-aware suggestions based on your writing style and vault content
- Support for other models, including local models
- Support for image inputs or external files (PDF, DOCX, etc.)
- Custom prompt templates and system prompts
- Mentioning with tags or other metadata

## Feedback and Support

Expand All @@ -131,6 +124,8 @@ Your feedback and experiences are crucial in making Smart Composer better for ev

We welcome all kinds of contributions to Obsidian Smart Composer, including bug reports, bug fixes, documentation improvements, and feature enhancements.

**For major feature ideas, please create an issue first to discuss feasibility and implementation approach.**

If you're interested in contributing, please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed information on:

- Setting up the development environment
Expand All @@ -139,7 +134,6 @@ If you're interested in contributing, please refer to our [CONTRIBUTING.md](CONT
- The process for submitting pull requests
- Known issues and solutions for developers

For major feature ideas, please create an issue first to discuss feasibility and implementation approach.

## License

Expand Down
Loading