Skip to content

Commit c7c9c7e

Browse files
authored
Update nuspec.md
1 parent d96275b commit c7c9c7e

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/reference/nuspec.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,38 @@ license-expression = 1*1(simple-expression / compound-expression / UNLICENSED)
139139
```
140140

141141
#### iconUrl
142+
143+
> [!Important]
144+
> licenseUrl is being deprecated. Use license instead.
145+
142146
A URL for a 64x64 image with transparency background to use as the icon for the package in UI display. Be sure this element contains the *direct image URL* and not the URL of a web page containing the image. For example, to use an image from GitHub, use the raw file URL like <em>https://github.com/\<username\>/\<repository\>/raw/\<branch\>/\<logo.png\></em>.
147+
148+
#### icon
149+
Path to an image file within the package, often shown in UIs like nuget.org as the package icon.
150+
151+
`<icon>icon.png</icon>`
152+
153+
For example, if you are using nuget.exe to create a package from a nuspec:
154+
155+
```xml
156+
<package>
157+
<metadata>
158+
...
159+
<icon>images\icon.png</icon>
160+
...
161+
</metadata>
162+
<files>
163+
...
164+
<file src="..\icon.png" target="images\" />
165+
...
166+
</files>
167+
</package>
168+
```
169+
170+
> [!Note]
171+
> NuGet.org accepts max image size of 1 Mb.
172+
173+
143174

144175
#### requireLicenseAcceptance
145176
A Boolean value specifying whether the client must prompt the consumer to accept the package license before installing the package.

0 commit comments

Comments
 (0)