From c10681814636ad704253b5c2e4b93b3de66854ed Mon Sep 17 00:00:00 2001 From: matmanna <91392083+matmanna@users.noreply.github.com> Date: Sat, 16 Aug 2025 09:19:23 -0400 Subject: [PATCH 1/3] :memo: Add demo video to README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index af43f2f..957372e 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,17 @@ This extension, obviously, but why? First off, Raycast is a super epic MacOS/Win ## πŸ“Ί Demo Video & Setup Tutorial + +https://github.com/user-attachments/assets/d10b786e-c00c-476f-9634-c253c732ee52 + + ## πŸš€ Usage To run this extension, simply: 1. Clone this repository to your device using `git clone` and navigate (`cd`) into it, and run the `npm run dev` script, -2. launch Raycast like usual and search for the "Regreso Login" command -3. Fill in your regreso account email/password (you can create one [here](https://regreso.netlify.app/sign-up), but make sure to use email/password!) and submit. -4. Start using Regreso for Raycast! You can use the commands described in +2. Launch Raycast like usual (alt+space maybe?) and search for "Settings". Inside of the Regreso settings menu (from the sidebar), provide your fill in your regreso account email/password (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. ## πŸ› οΈ Developing -- 2.51.2 From 15ccd845033168183727dbac562f0e9f35ce9797 Mon Sep 17 00:00:00 2001 From: matmanna <91392083+matmanna@users.noreply.github.com> Date: Sat, 16 Aug 2025 09:30:40 -0400 Subject: [PATCH 2/3] :memo: Improve README docs greatly --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 957372e..11f6b81 100644 --- a/README.md +++ b/README.md @@ -4,36 +4,34 @@ Welcome to Regreso for Raycast. This README primarily serves to help other developers setup, run, and collaborate the Regreso Raycast extension! -## πŸ‘‹ Introduction +## πŸ’¬ Introduction -Ever find yourself wanting to come back to an article, video, link, or manual at a later time but never actually doing it? (Regreso might be for you!) Or constantly having to launch the Regreso web [platform](https://regreso.netlify.app) everytime you find something amazing? +Ever find yourself wanting to come back to an article, video, link, or manual at a later time but never actually doing it? (Regreso might be for you!) Or find yourself constantly having to launch the Regreso web [platform](https://regreso.netlify.app) every time you stumble across something amazing? ### πŸ€” 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 features not supported on the Regreso platform (such as drafts), this extension will go farther to become an important client platform. +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. ### πŸ’ͺ 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. +- You use multiple machines regularly and want to be able to access your saved resources across browsers or (without) a browser at all. ## πŸ“Ί Demo Video & Setup Tutorial - https://github.com/user-attachments/assets/d10b786e-c00c-476f-9634-c253c732ee52 - ## πŸš€ Usage To run this extension, simply: -1. Clone this repository to your device using `git clone` and navigate (`cd`) into it, 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), provide your fill in your regreso account email/password (you can create one by signing up with email/password [here](https://regreso.netlify.app/sign-up)) and close settings +1. Clone this repository to your device using `git clone`, navigate (`cd`) into it, 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. 4. Start using Regreso for Raycast! You can use the commands described below or search "regreso" globally in Raycast. ## πŸ› οΈ Developing -Some useful commands when developing this extension include: +Some useful commands when using or developing the alpha version of this extension include: - `npm run dev` / `npm run build` - `npm run lint` / `npm run fix-lint` @@ -48,15 +46,17 @@ A list of the current commands available in the extension. ## βš™οΈ Configuration -> [!IMPORTANT] -> Only email/password account auth is fully supported by this client! Whilst GitHub login can be used through a session ID, obtained from session cookie, this will eventually expire and may eventually be deprecated from this extension. - The following configuration preferences can be set: - Instance URL (optional), **Default: https://regreso.netlify.app**: If self-hosting Regreso, enter your instance's web address here. - 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. +- Session ID (optional) Optional but overrides email/password fields in favor of a statically-provided session ID +- Auto Tagging (under Create Destination: Docs coming soon... + +## πŸ› Bugs and Features + +If you find a bug with Regreso itself, file it under the main repo's [issues](https://github.com/matmanna/Regreso). Otherwise, for client-specific problems or suggestions, create an issue on this repository! ## πŸ—ΊοΈ Roadmap -- 2.51.2 From 69b9c4abfbaf18db2576c19d95e10b1a3ec896d1 Mon Sep 17 00:00:00 2001 From: matmanna <91392083+matmanna@users.noreply.github.com> Date: Sat, 16 Aug 2025 22:05:35 -0400 Subject: [PATCH 3/3] :memo: Improve setup documentation --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 11f6b81..96a742b 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ https://github.com/user-attachments/assets/d10b786e-c00c-476f-9634-c253c732ee52 To run this extension, simply: -1. Clone this repository to your device using `git clone`, navigate (`cd`) into it, and run the `npm run dev` script, +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. 4. Start using Regreso for Raycast! You can use the commands described below or search "regreso" globally in Raycast. @@ -60,10 +60,6 @@ If you find a bug with Regreso itself, file it under the main repo's [issues](ht ## πŸ—ΊοΈ Roadmap -### πŸ“ A note about auth - -The most complicated thing about the Regreso Raycast extension is the need for secure, simple authentication. Because the extension doesn't just serve as an RSS-feed-reader but enables mutational procedures as well, caution is important. - ### β˜‘οΈ TODOs - [ ] Auth -- 2.51.2