zsh-users / zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.
github.com/zsh-users/zsh-syntax-highlighting
BSD 3-Clause "New" or "Revised" License
19.55k stars 1.32k forks source link

Add Fig as an installation method to the README #877

Closed ibayramli closed 1 year ago

ibayramli commented 2 years ago

The Fig Plugin Store supports 1-click install for 400+ shell plugins. We have over 100k users, thousands of whom manage their shell configuration with Fig.

Zsh Syntax Highlighting is already listed in the store so we'd love to have it listed as a download method on your readme.

Thanks so much and please let me know if you have any questions!

phy1729 commented 2 years ago

How's the below diff? I think it better matches the style of the rest of the page.

diff --git a/INSTALL.md b/INSTALL.md
index 48b724f..024dbd9 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -75,6 +75,12 @@ This list is incomplete as there are too many
 Add `antigen bundle zsh-users/zsh-syntax-highlighting` as the last bundle in
 your `.zshrc`.

+#### [Fig](https://fig.io)
+
+Click the `Install Plugin` button on the [Fig plugin page][fig-plugin].
+
+[fig-plugin]: https://fig.io/plugins/other/zsh-syntax-highlighting
+
 #### [Oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh)

 1. Clone this repository in oh-my-zsh's plugins directory:
brendanfalk commented 2 years ago

Hey @phy1729 thanks for the quick reply.

So, currently https://fig.io/plugins/other/zsh-syntax-highlighting is just a static landing page, however, we are about to push a change that deep links users who hit this page to Fig's desktop app and installs the plugin. So clicking this button will in fact let users instantly download it without an intermediary step. We think the button is more clear and so if possible would love to keep it - also means more downloads for zsh-syntax-highlighting!

We have this on a bunch of plugins / frameworks already e.g. https://github.com/sorin-ionescu/prezto

brendanfalk commented 2 years ago

Also, while I'm here, I love z-sy-h. We feature you heavily in our plugin store (and it's understandably one of the top downloaded plugins within Fig)! Plus, it's so visually appealing, we use it in all of our demos. Really awesome stuff!

CleanShot 2022-06-15 at 17 49 52@2x
phy1729 commented 2 years ago

I'm not fond of the button for a few reasons.

If the URL is changed to start an install rather than just be a landing page the text could be tweaked to indicated such. (Although an HTTP GET request resulting in a plugin getting installed seems against the spirit of the spec.)

brendanfalk commented 2 years ago

The image is external to the repository which is currently self contained. The image could allow for some tracking of users.

Understood! I'll have Ilkin update it to being hosted on the GitHub CDN using this url

No other installation method has an image.

Yes it's a fair point, however, most of the other methods have quite hefty multi-line code blocks. This is the value of Fig - for many, running shell commands is cumbersome and/or scary. Fig makes it easy.

If the URL is changed to start an install rather than just be a landing page the text could be tweaked to indicated such. (Although an HTTP GET request resulting in a plugin getting installed seems against the spirit of the spec.)

So to really clarify, the button will take you to the plugin splash screen (e.g. https://fig.io/plugins/zsh-syntax-highlighting). We then redirect to a deep link to Fig. If you have Fig installed, the deep link works and we prompt you to confirm installation one last time before it's installed. If you don't have Fig installed, we continue to display the plugin landing page and prompt you to install Fig to set it up.

Sorry, not trying to cause confusion here! We made the PR as we have been speaking to @danielshahaf for a while now and his most recent email suggested we should just go ahead and make it! Also, hi Daniel 👋, been a while, hope you are well!!

z0rc commented 2 years ago

We have over 100k users, thousands of whom manage their shell configuration with Fig.

This is pure advertisement and lies. The value of this PR is actually negative. Please don't merge it.

pcjmfranken commented 2 years ago

We think the button is more clear

What would be clarified by the button, though?

danielshahaf commented 2 years ago

I'm not too happy with the image because (1) we try to keep the markdown usable even in source form, not only in rendered form; and (2) no other installation method has anything comparable to Fig's badge, and we don't pick favourites among our downstreams.

What might work is to add Fig's logo. Most of the other installation options (all distros and some of the plugin managers) have logos too, so adding logos (to all installation options, not just to Fig) wouldn't break parity. [edit: This is now #902.]

brendanfalk commented 1 year ago

@phy1729 @danielshahaf - My apologies for massive delay here (have just been cleaning out my GH notifications)

I've updated the PR factoring in you commentary above. Totally understand the concerns about the button, I've removed it.

Intention is not to be markety or salesy. We truly do have a bunch of users, z-sy-h is incredibly popular (we feature it heavily in our store), and having us listed as an install method helps other users quickly download it.

Apologies again for the issues above - please let me know if any more questions/concerns!

Brendan