Skip to content

chore: add deeplinks to vscode, cursor installs #289

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.

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

Merged
merged 5 commits into from
Jun 10, 2025
Merged

Conversation

nirinchev
Copy link
Collaborator

@nirinchev nirinchev commented Jun 9, 2025

This is an alternative to #288.

The difference is that we don't try to pass on any config parameters as I don't think it's obvious users have to update the config after installation. Additionally, I've moved the badges to the top of the readme and made them consistent visual style.

@Copilot Copilot AI review requested due to automatic review settings June 9, 2025 10:38
@nirinchev nirinchev requested a review from a team as a code owner June 9, 2025 10:38
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the README by adding deeplink badges for easy installation in VS Code and Cursor, along with a link to view the project on Smithery.

  • Added a VS Code install badge with an embedded base64 logo
  • Added a Cursor install badge with an embedded base64 logo
  • Added a Smithery view badge
Comments suppressed due to low confidence (2)

README.md:1

  • [nitpick] Consider externalizing the embedded base64 image data to an external asset file for easier future updates and improved readability of the badge link.
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIgdmlld0JveD0iMCAwIDEwMCAxMDAiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxnIGNsaXAtcGF0aD0idXJsKCNjbGlwMCkiPgo8ZyBmaWx0ZXI9InVybCgjZmlsdGVyMF9kKSI+CjxtYXNrIGlkPSJtYXNrMCIgbWFzay10eXBlPSJhbHBoYSIgbWFza1VuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeD0iMCIgeT0iMCIgd2lkdGg9IjEwMCIgaGVpZ2h0PSIxMDAiPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTcwLjkxMTkgOTkuNTcyM0M3Mi40ODY5IDEwMC4xODkgNzQuMjgyOCAxMDAuMTUgNzUuODcyNSA5OS4zODA3TDk2LjQ2MDQgODkuNDIzMUM5OC42MjQgODguMzc3MSAxMDAgODY2MTc2MiAxMDAgODMuNzYxNlYxNi4yMzkyQzEwMCAxMy44MjQ3IDk4LjYyNCAxMS42MjM4IDk2LjQ2MDQgMTAuNTc3NEw3NS44NzI1IDAuNjE5MDY3QzczLjc4NjIgLTAuMzg5OTkxIDcxLjM0NDYgLTAuMTQyODg1IDY5LjUxMzUgMS4xOTUyN0M2OS4yNTIgMS4zODYzNiA2OS4wMDI4IDEuNTk5ODUgNjguNzY5IDEuODM1MDJMMjkuMzU1MSAzNy45Nzk1TDEyLjE4NzIgMjQuODhDMTAuNTg5MSAyMy42NjA3IDguMzUzNjUgMjMuNzYwNiA2Ljg2OTM4IDI1LjExNzhMMS4zNjMwMiAzMC4xNTI1Qy0wLjQ1MjYwMyAzMS44MTI3IC0wLjQ1NDU4MyAzNC42ODM3IDEuMzU4NTQgMzYuMzQ2NkwxNi4yNDcxIDUwLjAwMDFMMS4zNTg1NCA2My42NTM2Qy0wLjQ1NDU4MyA2NS4zMTY0IC0wLjQ1MjYwMyA2OC4xODc2IDEuMzYzMDIgNjkuODQ3Nkw2LjgxMjUgNzQuODgyM0M4LjI5NzcxIDc2LjIzOTUgMTAuNTM0NSA3Ni4zMzkgMTIuMTMzNSA3NS4xMjAxTDI5LjM1NTEgNjIuMDIwN0w2OC43NjkgOTguMTY1MUM2OS4zOTI1IDk4Ljc5MjMgNzAuMTI0NiA5OS4yNjQ1IDcwLjkxMTkgOTkuNTcyM1pNNzUuMDE1MiAyNy4xODEzTDQ1LjEwOTIgNTAuMDAwMUw3NS4wMTUyIDcyLjgxODlWMjcuMTgxM1oi

README.md:2

  • [nitpick] Consider externalizing the embedded base64 image data to an external asset file for easier maintenance and readability of the badge link.
[![Install in Cursor](https://img.shields.io/badge/Cursor-Install_Server-1e1e1e?logo=data:image/svg%2bxml;base64,PHN2ZyBoZWlnaHQ9IjFlbSIgc3R5bGU9ImZsZXg6bm9uZTtsaW5lLWhlaWdodDoxIiB2aWV3Qm94PSIwIDAgMjQgMjQiIHdpZHRoPSIxZW0iCiAgICB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogICAgPHRpdGxlPkN1cnNvcjwvdGl0bGU+CiAgICA8cGF0aCBkPSJNMTEuOTI1IDI0bDEwLjQyNS02LTEwLjQyNS02TDEuNSAxOGwxMC40MjUgNnoiCiAgICAgICAgZmlsbD0idXJsKCNsb2JlLWljb25zLWN1cnNvcnVuZGVmaW5lZC1maWxsLTApIj48L3BhdGg+CiAgICA8cGF0aCBkPSJNMjIuMzUgMThWNkwxMS45MjUgMHYxMmwxMC40MjUgNnoiIGZpbGw9InVybCgjbG9iZS1pY29ucy1jdXJzb3J1bmRlZmluZWQtZmlsbC0xKSI+PC9wYXRoPgogICAgPHBhdGggZD0iTTExLjkyNSAwTDEuNSA2djEybDEwLjQyNS02VjB6IiBmaWxsPSJ1cmwoI2xvYmUtaWNvbnMtY3Vyc29ydW5kZWZpbmVkLWZpbGwtMikiPjwvcGF0aD4KICAgIDxwYXRoIGQ9Ik0yMi4zNSA2TDExLjkyNSAyNFYxMkwyMi4zNSA2eiIgZmlsbD0iIzU1NSI+PC9wYXRoPgogICAgPHBhdGggZD0iTTIyLjM1IDZsLTEwLjQyNSA2TDEuNSA2aDIwLjg1eiIgZmlsbD0iI2ZmZiI+PC9wYXRoPgogICAgPGRlZnM+CiAgICAgICAgPGxpbmVhckdyYWRpZW50IGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIiBpZD0ibG9iZS1pY29ucy1jdXJzb3J1bmRlZmluZWQtZmlsbC0wIgogICAgICAgICAgICB4MT0iMTEuOTI1IiB4Mj0iMTEuOTI1IiB5MT0iMTIiIHkyPSIyNCI+CiAgICAgICAgICAgIDxzdG9wIG9mZnNldD0iLjE2IiBzdG9wLWNvbG9yPSIjZmZmIiBzdG9wLW9wYWNpdHk9Ii4zOSI+PC9zdG9wPgogICAgICAgICAgICA8c3RvcCBvZmZzZXQ9Ii42NTgiIHN0b3AtY29sb3I9IiNmZmYiIHN0b3Atb3BhY2l0eT0iLjgiPjwvc3RvcD4KICAgICAgICA8L2xpbmVhckdyYWRpZW50PgogICAgICAgIDxsaW5lYXJHcmFkaWVudCBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgaWQ9ImxvYmUtaWNvbnMtY3Vyc29ydW5kZWZpbmVkLWZpbGwtMSIKICAgICAgICAgICAgeDE9IjIyLjM1IiB4Mj0iMTEuOTI1IiB5MT0iNi4wMzciIHkyPSIxMi4xNSI+CiAgICAgICAgICAgIDxzdG9wIG9mZnNldD0iLjE4MiIgc3RvcC1jb2xvcj0iI2ZmZiIgc3RvcC1vcGFjaXR5PSIuMzEiPjwvc3RvcD4KICAgICAgICAgICAgPHN0b3Agb2Zmc2V0PSIuNzE1IiBzdG9wLWNvbG9yPSIjZmZmIiBzdG9wLW9wYWNpdHk9IjAiPjwvc3RvcD4KICAgICAgICA8L2xpbmVhckdyYWRpZW50PgogICAgICAgIDxsaW5lYXJHcmFkaWVudCBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgaWQ9ImxvYmUtaWNvbnMtY3Vyc29ydW5kZWZpbmVkLWZpbGwtMiIKICAgICAgICAgICAgeDE9IjExLjkyNSIgeDI9IjEuNSIgeTE9IjAiIHkyPSIxOCI+CiAgICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9IiNmZmYiIHN0b3Atb3BhY2l0eT0iLjYiPjwvc3RvcD4KICAgICAgICAgICAgPHN0b3Agb2Zmc2V0PSIuNjY3IiBzdG9wLWNvbG9yPSIjZmZmIiBzdG9wLW9wYWNpdHk9Ii4yMiI+PC9zdG9wPgogICAgICAgIDwvbGluZWFyR3JhZGllbnQ+CiAgICA8L2RlZnM+Cjwvc3ZnPg==

@nirinchev nirinchev changed the title Add deeplinks to vscode and cursor installs chore: add deeplinks to vscode and cursor installs Jun 9, 2025
Copy link
Collaborator

@blva blva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@nirinchev nirinchev changed the title chore: add deeplinks to vscode and cursor installs chore: add deeplinks to vscode, cursor, and windsurf installs Jun 9, 2025
This reverts commit 4a6a662.
@nirinchev nirinchev changed the title chore: add deeplinks to vscode, cursor, and windsurf installs chore: add deeplinks to vscode, cursor installs Jun 10, 2025
@nirinchev nirinchev merged commit ba6350c into main Jun 10, 2025
19 checks passed
@nirinchev nirinchev deleted the ni/deeplinks branch June 10, 2025 14:58
@nirinchev
Copy link
Collaborator Author

Pulling windsurf out for now since we need an http link there rather than an app link to play nicely with github readmes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants