CODEWITHSUNDEEP
githubnuget
Jonathan Wood
Jonathan Wood

Reputation: 67223

Linking to NuGet from GitHub

I have a repository on GitHub and I've created a corresponding packing on NuGet. I would like to link to the NuGet package from my GitHub README file.

After modifying some text I found on other repositories, I came up with the following:

[![NuGet version (SoftCircuits.Silk)](https://img.shields.io/nuget/v/SoftCircuits.Silk.svg?style=flat-square)](https://www.nuget.org/packages/SoftCircuits.Silk/)

In a GitHub MD file (and here), this produces the following link:

NuGet version (SoftCircuits.Silk)

That seems good but I'd like to find more about this. After Googling for quite a while, I haven't been able to find where these type of links are documented. Do I have the correct usage? Are there other options I might want to take advantage of? And so on?

Is there a reference for these type of links somewhere?

Upvotes: 17

Views: 3950

Answers (1)

Nikolas Stevenson-Molnar
Nikolas Stevenson-Molnar

Reputation: 4710

Your link comes from the service shields.io, which offers badge images for all sorts of services and all sorts of info. The reason you had a hard time finding documentation is probably because badges aren't GitHub specific, that's just one place you can use them. So if you search for "nuget badge" instead of "nuget github", you'll find the shields.io site is the first result.

As for documentation, it's all at shields.io. Click "Version" and scroll down to see the specific NuGet badge that you're using. There are badges for a lot of other information (size, # of downloads, etc) there, too.

Upvotes: 18

Related Questions