diff --git a/README.md b/README.md index 3cbafea..7ca028e 100644 --- a/README.md +++ b/README.md @@ -10,31 +10,35 @@ Ever find yourself wanting to come back to an article, video, link, or manual at ### πŸ€” What's the Solution? -This extension (obviously) but why? First off, Raycast is a super epic MacOS/Windows app that allows you to quickly execute commands to do things like launch apps, find files, perform simple calculations, translate text, etc from the comfort of a conveniently-shortcutted command palette. But this extension gives you the added power of **saving your links and richly-formatted notes**. Additionally, with planned features not supported on the Regreso platform (such as drafts), this extension will hopefully become an important platform client. +This extension (obviously) but why? + +1. Raycast is a super epic MacOS/Windows app that allows you to quickly execute commands to do things like launch apps, find files, perform simple calculations, translate text, etc from the comfort of a conveniently-shortcutted command palette. +2. This extension gives you the added power of **saving links and richly-formatted notes you wish to return to later**. Additionally, with planned features not supported on the Regreso platform (such as drafts and browser integration), this extension will become an important platform client. ### πŸ’ͺ Example Use Cases -- You somehow ended up with 50 tabs generated from some niche rabbit-hole research on a topic and need to quickly organize them all into maps and workspaces. -- You use multiple machines regularly and want to be able to access your saved resources across browsers or (without) a browser at all. +- You somehow ended up with a boatload of tabs generated during a niche rabbit-hole research session on a variety of topics and need to quickly organize them all into maps and workspaces for future reference. +- You use multiple machines (or browsers) regularly and want to be able to access your saved resources across browsers or (without) a browser at all. ## πŸ“Ί Demo & Setup Video -> [!WARNING] -> This extension is only tested on Windows but should work cross-platform. Feel free to try on MacOS and if you encounter any problems, file an issue! - https://github.com/user-attachments/assets/d10b786e-c00c-476f-9634-c253c732ee52 ## πŸš€ Getting Started -To run this extension, simply: +> [!WARNING] +> This extension is only tested on Windows but should work cross-platform. Feel free to try on MacOS and if you encounter any problems, file an issue! + +To get started with this extension, follow these steps: -1. Clone this repository to your device using `git clone`, navigate (`cd`) into it, install dependencies (`npm install`), and run the `npm run dev` script, -2. Launch Raycast like usual (alt+space maybe?) and search for "Settings". Inside of the Regreso settings menu (from the sidebar), fill in your regreso account credentials (you can create one by signing up with email/password [here](https://regreso.netlify.app/sign-up)) and close settings. -3. Start using Regreso for Raycast! You can use the commands described below or search "regreso" globally in Raycast. +1. **Clone this repository** to your device using `git clone https://github.com/matmanna/raycasting.git` and **cd into it**: `cd raycasting` +2. **Run install script**: `npm install`, then **run the development script**: `npm run dev` (once it's successfully running, feel free to press `Ctrl+C` or close the terminal window) +3. **Open Raycast** like usual (`alt+space` maybe?) and **search for "Settings"**. In the Regreso settings menu (from the left sidebar), **fill in your account credentials** (you can create one by signing up with email/password [here](https://regreso.netlify.app/sign-up)) and **close settings**. +4. **Start using Regreso for Raycast!** You can use the commands described below or search "regreso" globally in Raycast. ## ⌨️ Commands -A list of the current commands available in the extension. +A list of the current commands available in the extension: - Create Destination - List Destinations @@ -47,7 +51,8 @@ The following configuration preferences can be set: - Email (mandatory): If using session id auth, just write something random in this field. - Password (mandatory): : If using session id auth, just write something random in this field. - Session ID (optional) Optional but overrides email/password fields in favor of a statically-provided session ID -- Auto Tagging (under Create Destination): Disabled by default, you can provide an AI api url (more specifications coming soon) which will be used to generate destination tags. +- AI Tagging: Disabled by default which will be used to generate destination tags. +- AI Instance: Defaults to `https://ai.hackclub.com`; If AI tagging is enabled, this URL will be used to send auto-tagging requests. (future authentication config will be available) ## πŸ› Bugs and Features @@ -55,19 +60,25 @@ If you find a bug with Regreso itself, file it under the main repo's [issues](ht ## πŸ—ΊοΈ Roadmap +The following TODOs serve as the main project-planning source for this repository: + ### β˜‘οΈ TODOs - [ ] Auth - [x] basic email/password or session token - - [ ] Support Regreso OAuth + - [ ] Support Regreso OAuth (better) - [ ] Support destination commands - [x] Support creating destinations - [x] scraped metadata + - [ ] basic ai tagging + - [ ] authenticated ai tagging + - [ ] local ai tagging - [ ] with arguments - [ ] searchable tagpicker - [ ] Support browser tab integrations - [ ] Support browser bookmarks integrations - - [ ] Support saving destination drafts + - [ ] Store submitted dests locally in some sort of SQL sync-outbox if no internet connection available + - [ ] Support saving destination drafts (somehow differentiation from sync waitlist) - [x] Support listing/searching destinations - [x] List item details - [ ] Hide details action (& preferences) @@ -77,8 +88,6 @@ If you find a bug with Regreso itself, file it under the main repo's [issues](ht - [ ] Support listing/searching maps - [ ] Support opening maps (listing destinations) -- [ ] Store some data locally (SQL) - - [ ] Release Stuff - [ ] Test on MacOS - [ ] CI/CD GitHub Actions (CI-only for now) diff --git a/package.json b/package.json index 936ceac..bbb552b 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,7 @@ "name": "regreso", "title": "Regreso", "description": "Create destinations for resources you want to return to later, manage maps, trunks, and tags.", + "version": "0.1.0-alpha", "icon": "extension-icon.png", "author": "regreso", "license": "MIT", @@ -11,24 +12,7 @@ "name": "create-destination", "title": "Create Destination", "description": "Creates a new destination, which can be a URL or note.", - "mode": "view", - "arguments": [ - { - "name": "title", - "placeholder": "Title", - "type": "text" - }, - { - "name": "url", - "placeholder": "URL", - "type": "text" - }, - { - "name": "trunk", - "placeholder": "Trunk ID", - "type": "text" - } - ] + "mode": "view" }, { "name": "list-destinations", diff --git a/src/create-destination.tsx b/src/create-destination.tsx index e6ce533..412a65d 100644 --- a/src/create-destination.tsx +++ b/src/create-destination.tsx @@ -90,12 +90,10 @@ export default function CreateDestination( }); }); }, [setWorkspaces, sessionToken]); - const { title, url, trunk } = props.arguments ?? { title: "", url: "", trunk: undefined }; - const { itemProps: destinationTypeProps } = useForm({ initialValues: props.draftValues || { type: "location", - location: url || "", + location: "", }, onSubmit: () => {}, }); @@ -103,11 +101,11 @@ export default function CreateDestination( const { itemProps: destinationProps } = useForm({ initialValues: props.draftValues || { type: "location", - location: url || undefined, - headline: title || "", + location: undefined, + headline: "", body: "", tags: "", - workspaceId: trunk ?? defaultWorkspace ?? "0", + workspaceId: defaultWorkspace ?? "0", }, onSubmit: () => {}, });