Skip to content

Commit

Permalink
feat: update
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenvanduocit committed Feb 5, 2023
1 parent fca2a11 commit 59d61d2
Show file tree
Hide file tree
Showing 13 changed files with 2,094 additions and 1,450 deletions.
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ A plugin for Obsidian that uses OpenAI's API to assist users in their note-takin

## Features

- [x] File rename: Suggest a new name for the file based on its content.
- [ ] Text completion: Suggest text based on what the user has already written, making it easier to write and faster to complete thoughts.
- [ ] Text correction: The plugin can identify and suggest corrections for spelling, grammar, and style errors in real-time, making it easier to produce error-free writing.
- [ ] Question answering: Answer questions based on the text in the note, providing quick access to information without leaving Obsidian.
- [x] File rename: Suggest a new name for the file based on its content.
- [x] Text completion: Suggest text based on what the user has already written, making it easier to write and faster to complete thoughts.
- [ ] Text correction: The plugin can identify and suggest corrections for spelling, grammar, and style errors in real-time, making it easier to produce error-free writing.
- [ ] Question answering: Answer questions based on the text in the note, providing quick access to information without leaving Obsidian.

## Usage

Expand All @@ -18,22 +18,40 @@ A plugin for Obsidian that uses OpenAI's API to assist users in their note-takin
1. Right-click on a file in the file explorer and select "AI Rename".
2. The plugin will suggest a new name for the file based on its content.

[View demo](https://www.youtube.com/watch?v=0cWN_JhoZm4)

### Text completion

TBD
1. Type your text in the editor.
2. Use palette command `AI Complete` to get suggestions.

### Text correction
If your cursor is at the end of the paragraph, the plugin will suggest text to complete the paragraph. If your cursor is in the new line, the plugin will suggest text based on the whole document.

TBD
[View demo](https://www.youtube.com/watch?v=qU3DSY7eXA8)


### Text summarization

1. Select the text you want to summarize.
2. Press right-click and select "AI Summarize".

[View demo](https://www.youtube.com/watch?v=qU3DSY7eXA8)

### Text explanation

1. Select the text you want to explain.
2. Press right-click and select "AI Explain".

[View demo](https://www.youtube.com/watch?v=qU3DSY7eXA8)

### Question answering

TBD

## Requirements

- Obsidian v0.9.8 or later
- An OpenAI API key
- Obsidian v0.9.8 or later
- An OpenAI API key

## Support

Expand Down
26 changes: 13 additions & 13 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"id": "ai-assistant",
"name": "AI Assistant",
"version": "0.0.5",
"minAppVersion": "0.15.0",
"description": "Embed any website to Obsidian, from now all, you have anything you need in one place.",
"author": "duocnv",
"authorUrl": "https://twitter.com/duocdev",
"fundingUrl": {
"Buy Me a Coffee": "https://paypal.me/duocnguyen",
"Follow me": "https://twitter.com/duocdev"
},
"isDesktopOnly": true
}
"id": "ai-assistant",
"name": "AI Assistant",
"version": "0.0.5",
"minAppVersion": "0.15.0",
"description": "Embed any website to Obsidian, from now all, you have anything you need in one place.",
"author": "duocnv",
"authorUrl": "https://twitter.com/duocdev",
"fundingUrl": {
"Buy Me a Coffee": "https://paypal.me/duocnguyen",
"Follow me": "https://twitter.com/duocdev"
},
"isDesktopOnly": true
}
Loading

0 comments on commit 59d61d2

Please sign in to comment.