Skip to content

Commit 52a1f60

Browse files
authored
Update NuGet Client SDK docs to include all published packages (#3176)
1 parent b2bd404 commit 52a1f60

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

docs/reference/NuGet-Client-SDK.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,23 @@ ms.topic: conceptual
1111

1212
The *NuGet Client SDK* refers to a group of NuGet packages:
1313

14-
* [`NuGet.Protocol`](https://www.nuget.org/packages/NuGet.Protocol) - Used to interact with HTTP and file-based NuGet feeds
15-
* [`NuGet.Packaging`](https://www.nuget.org/packages/NuGet.Packaging) - Used to interact with NuGet packages. `NuGet.Protocol` depends on this package
14+
* [`NuGet.Indexing`](https://www.nuget.org/packages/NuGet.Indexing) - NuGet's indexing library for the Visual Studio client search functionality.
15+
* [`NuGet.Commands`](https://www.nuget.org/packages/NuGet.Commands) - Complete commands common to command-line and GUI NuGet clients.
16+
* [`NuGet.Common`](https://www.nuget.org/packages/NuGet.Common) - Common utilities and interfaces for all NuGet libraries.
17+
* [`NuGet.Configuration`](https://www.nuget.org/packages/NuGet.Configuration) - NuGet's configuration settings implementation.
18+
* [`NuGet.Credentials`](https://www.nuget.org/packages/NuGet.Credentials) - NuGet client's authentication models.
19+
* [`NuGet.DependencyResolver.Core`](https://www.nuget.org/packages/NuGet.DependencyResolver.Core) - NuGet's PackageReference dependency resolver implementation.
20+
* [`NuGet.Frameworks`](https://www.nuget.org/packages/NuGet.Frameworks) - NuGet's understanding of target frameworks.
21+
* [`NuGet.LibraryModel`](https://www.nuget.org/packages/NuGet.LibraryModel) - NuGet's types and interfaces for understanding dependencies.
22+
* [`NuGet.Localization`](https://www.nuget.org/packages/NuGet.Localization) - NuGet localization package.
23+
* [`NuGet.PackageManagement`](https://www.nuget.org/packages/NuGet.PackageManagement) - NuGet Package Management functionality for Visual Studio installation flow.
24+
* [`NuGet.Packaging`](https://www.nuget.org/packages/NuGet.Packaging) - Provides a set of APIs to interact with `.nupkg` and `.nuspec` files from a stream. `NuGet.Protocol` depends on this package.
25+
* [`NuGet.ProjectModel`](https://www.nuget.org/packages/NuGet.ProjectModel) - NuGet's core types and interfaces for PackageReference-based restore, such as lock files, assets file and internal restore models.
26+
* [`NuGet.Protocol`](https://www.nuget.org/packages/NuGet.Protocol) - Provides a set of APIs interact with HTTP and file-based NuGet feeds.
27+
* [`NuGet.Resolver`](https://www.nuget.org/packages/NuGet.Resolver) - NuGet's dependency resolver for packages.config based projects.
28+
* [`NuGet.Versioning`](https://www.nuget.org/packages/NuGet.Versioning) - NuGet's implementation of Semantic Versioning.
1629

1730
You can find the source code for these packages in the [NuGet/NuGet.Client](https://github.com/NuGet/NuGet.Client) GitHub repository.
18-
You can find the source code for these examples on the [NuGet.Protocol.Samples](https://github.com/NuGet/Samples/tree/main/NuGetProtocolSamples) project on GitHub.
1931

2032
> [!Note]
2133
> For documentation on the NuGet server protocol, please refer to the [NuGet Server API](~/api/overview.md).
@@ -28,6 +40,8 @@ Install the `NuGet.Protocol` package to interact with HTTP and folder-based NuGe
2840
dotnet add package NuGet.Protocol
2941
```
3042

43+
You can find the source code for these examples on the [NuGet.Protocol.Samples](https://github.com/NuGet/Samples/tree/main/NuGetProtocolSamples) project on GitHub.
44+
3145
> [!Tip]
3246
> `Repository.Factory` is defined in the `NuGet.Protocol.Core.Types` namespace, and the `GetCoreV3` method is an extension method defined in the `NuGet.Protocol` namespace. Therefore, you will need to add `using` statements for both namespaces.
3347
@@ -94,7 +108,7 @@ Create a package, set metadata, and add dependencies using [`NuGet.Packaging`](h
94108
> It is strongly recommended that NuGet packages are created using the official NuGet tooling and **not** using this
95109
> low-level API. There are a variety of characteristics important for a well-formed package and the latest version of
96110
> tooling helps incorporate these best practices.
97-
>
111+
>
98112
> For more information about creating NuGet packages, see the overview of the
99113
> [package creation workflow](../create-packages/overview-and-workflow.md) and the documentation for official pack
100114
> tooling (for example, [using the dotnet CLI](../create-packages/creating-a-package-dotnet-cli.md)).
@@ -111,14 +125,14 @@ Read a package from a file stream using [`NuGet.Packaging`](https://www.nuget.or
111125

112126
You can find examples and documentation for some of the API in the following blog series by Dave Glick, published 2016:
113127

114-
- [Exploring the NuGet v3 Libraries, Part 1: Introduction and concepts](http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-1)
115-
- [Exploring the NuGet v3 Libraries, Part 2: Searching for packages](http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-2)
116-
- [Exploring the NuGet v3 Libraries, Part 3: Installing packages](http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-3)
128+
* [Exploring the NuGet v3 Libraries, Part 1: Introduction and concepts](http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-1)
129+
* [Exploring the NuGet v3 Libraries, Part 2: Searching for packages](http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-2)
130+
* [Exploring the NuGet v3 Libraries, Part 3: Installing packages](http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-3)
117131

118132
> [!Note]
119133
> These blog posts were written shortly after the **3.4.3** version of the NuGet client SDK packages were released.
120134
> Newer versions of the packages may be incompatible with the information in the blog posts.
121135
122136
Martin Björkström did a follow-up blog post to Dave Glick's blog series where he introduces a different approach on using the NuGet Client SDK to install NuGet packages:
123137

124-
- [Revisiting the NuGet v3 Libraries](https://martinbjorkstrom.com/posts/2018-09-19-revisiting-nuget-client-libraries)
138+
* [Revisiting the NuGet v3 Libraries](https://martinbjorkstrom.com/posts/2018-09-19-revisiting-nuget-client-libraries)

0 commit comments

Comments
 (0)