docs: update README
77
README.md
|
@ -1,3 +1,76 @@
|
|||
# Post to Akkoma
|
||||
# Raycast Extension for Akkoma
|
||||
|
||||
Write a new post and send it to Akkoma
|
||||
<img src="./assets/command.png" alt="commands of this plugin" style="width:500px;">
|
||||
|
||||
|
||||
- [Akkoma](https://akkoma.social/)
|
||||
- [Raycast](https://raycast.com)
|
||||
|
||||
**Features**:
|
||||
- Write status with markdown support.
|
||||
- Publish simple status with text.
|
||||
- Publish scheduled status with natural date format.
|
||||
- Publish status with attachments (image, video, files); add alt text to the image when only one image is attached.
|
||||
- Save draft status.
|
||||
- View your bookmarked statuses.
|
||||
- View your latest statuses.
|
||||
- Open the latest published status that was published from Raycast through the actions.
|
||||
|
||||
## Settings
|
||||
|
||||
Input your Akkoma / Pleroma instance's URL, then click the "Continue" button in the bottom-right corner.
|
||||
|
||||
<img src="./assets/login.png" alt="login" style="width:500px;">
|
||||
|
||||
## Examples:
|
||||
|
||||
### Add simple status with text
|
||||
|
||||
<img src="./assets/add-simple-status.png" alt="Add simple status with text" style="width:500px;">
|
||||
|
||||
### Add scheduled status
|
||||
|
||||
<img src="./assets/add-scheduled-status.png" alt="Add scheduled status" style="width:500px;">
|
||||
|
||||
### Add status with image and alt text
|
||||
|
||||
<img src="./assets/add-status-alt-text.png" alt="Add status with image and alt text" style="width:500px;">
|
||||
|
||||
### View bookmarked status
|
||||
|
||||
<img src="./assets/view-bookmarks.png" alt="Add simple status with text" style="width:500px;">
|
||||
|
||||
### View your latest status
|
||||
|
||||
<img src="./assets/view-my-status.png" alt="View your latest status" style="width:500px;">
|
||||
|
||||
### Mark status as sensitive
|
||||
Toggle the "Sensitive" checkbox to mark the attached image as sensitive, or add a content warning to the status.
|
||||
|
||||
<img src="./assets/add-cw.png" alt="View your latest status" style="width:500px;">
|
||||
|
||||
### Write status with markdown
|
||||
Toggle the "Markdown" checkbox to render markdown in the text file. Markdown shortcuts are also supported (e.g., pressing `⌘` + `B` will add `**bold**` around the selected text, `⌘` + `I` will make the selected text italic, etc.).
|
||||
|
||||
<img src="./assets/markdown.png" alt="Writing status with markdown" style="width:500px;">
|
||||
|
||||
## Available Settings
|
||||
|
||||
### Status limit
|
||||
Based on performance considerations, the number of statuses displayed is limited, with the default being 20. You can adjust this limit in the extension settings.
|
||||
|
||||
<img src="./assets/setting-bookmarks.png" alt="bookmark limit" style="width:500px;">
|
||||
|
||||
<img src="./assets/setting-status.png" alt="status limit" style="width:500px;">
|
||||
|
||||
### Default visibility
|
||||
|
||||
<img src="./assets/setting-visibility.png" alt="Default visibility" style="width:500px;">
|
||||
|
||||
## Actions
|
||||
<img src="./assets/actions.png" alt="actions" style="width:200px;">
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Bubble Visibility
|
||||
- [ ] Fork to Mastodon
|
||||
|
|
BIN
assets/actions.png
Normal file
After Width: | Height: | Size: 75 KiB |
BIN
assets/add-cw.png
Normal file
After Width: | Height: | Size: 342 KiB |
BIN
assets/add-scheduled-status.png
Normal file
After Width: | Height: | Size: 378 KiB |
BIN
assets/add-simple-status.png
Normal file
After Width: | Height: | Size: 340 KiB |
BIN
assets/add-status-alt-text.png
Normal file
After Width: | Height: | Size: 346 KiB |
BIN
assets/add-status.png
Normal file
After Width: | Height: | Size: 361 KiB |
BIN
assets/command.png
Normal file
After Width: | Height: | Size: 248 KiB |
BIN
assets/draft-status.png
Normal file
After Width: | Height: | Size: 409 KiB |
BIN
assets/login.png
Normal file
After Width: | Height: | Size: 348 KiB |
BIN
assets/markdown.png
Normal file
After Width: | Height: | Size: 364 KiB |
BIN
assets/setting-bookmarks.png
Normal file
After Width: | Height: | Size: 229 KiB |
BIN
assets/setting-status.png
Normal file
After Width: | Height: | Size: 239 KiB |
BIN
assets/setting-visibility.png
Normal file
After Width: | Height: | Size: 310 KiB |
BIN
assets/view-bookmarks.png
Normal file
After Width: | Height: | Size: 628 KiB |
BIN
assets/view-my-status.png
Normal file
After Width: | Height: | Size: 598 KiB |
|
@ -37,7 +37,7 @@ export default function BookmarkCommand() {
|
|||
{bookmarks?.map((bookmark) => (
|
||||
<List.Item
|
||||
title={bookmark.pleroma.content["text/plain"] || bookmark.akkoma.source.content}
|
||||
key={bookmark.id}
|
||||
key={bookmark.uri}
|
||||
detail={<List.Item.Detail markdown={statusParser(bookmark, "idAndDate")} />}
|
||||
actions={
|
||||
<ActionPanel>
|
||||
|
|
|
@ -74,6 +74,7 @@ export interface Status {
|
|||
acct: string;
|
||||
};
|
||||
url: string;
|
||||
uri: string;
|
||||
content: string;
|
||||
pleroma: {
|
||||
content: {
|
||||
|
|