commit 2b3923e40d770ae0b19ec83dc1571eec7d59a9d8
parent 8340ee2738b2cb73f5f69db425e96705b35675a6
Author: denelon <denelon@microsoft.com>
Date: Thu, 21 Apr 2022 12:04:10 -0700
Update README (#2113)
* Update README.md
* Added telemetry settings
And corrected a typo
* Update README.md
Co-authored-by: Ryan Fu <69221034+ryfu-msft@users.noreply.github.com>
Co-authored-by: Ryan Fu <69221034+ryfu-msft@users.noreply.github.com>
Diffstat:
1 file changed, 11 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-# Welcome to the Windows Package Manager Client (aka winget.exe) repository
+# Windows Package Manager Client
-This repository contains the source code for the Windows Package Manager Client (aka winget.exe).
+This repository contains the source code for the Windows Package Manager Client.
-The packages available to the client are in the [Community repo](https://github.com/microsoft/winget-pkgs).
+If you are new to the Windows Package Manager, you might want to [Explore the Windows Package Manager tool](https://docs.microsoft.com/learn/modules/explore-windows-package-manager-tool/?WT.mc_id=AZ-MVP-5004737). The packages available to the client are in the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs).
## Installing The Client
@@ -53,11 +53,12 @@ You can also [build the client yourself](#building-the-client). While the client
[](https://dev.azure.com/ms/winget-cli/_build/latest?definitionId=344&branchName=master)
## Windows Package Manager Release Roadmap
-The plan for delivering next Windows Package Manager release [is described here](doc/windows-package-manager-release-roadmap.md), and will be updated as the project proceeds.
+The plan for delivering next Windows Package Manager releases is described included in our [discussions](https://github.com/microsoft/winget-cli/discussions/2063), and will be updated as the project proceeds.
## Overview of the Windows Package Manager
-The **Windows Package Manager** is a tool designed to help you quickly and easily discover and install those tools that make your PC environment special. By using the **Windows Package Manager**, from one command, you can install your favorite tool:
-```winget install <tool>```
+The **Windows Package Manager** is a tool designed to help you quickly and easily discover and install those packages that make your PC environment special. By using the **Windows Package Manager**, from one command, you can install your favorite packages:
+
+`winget install <package>`
## Overview
@@ -67,13 +68,9 @@ This winget-cli repository includes the source code designed to build the client
### Sources
The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retrieve the metadata about the packages, so that the client can act on it.
-The default source reflects that data available from the [Community repo](https://github.com/microsoft/winget-pkgs).
-
-We plan to better support additional sources, and additional types of sources, in the future. For now, additional sources can be configured, but only one used at a time.
-
-### Package Manager Service
-The **Package Manager Service** is responsible for approving Pull Requests. It validates the YAML and [manifest spec](/doc/ManifestSpecv1.0.md) for spec compliance.
-
+* The default "winget" source includes packages in the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs).
+* The default "msstore" source includes packages in the Microsoft Store.
+* It is also possible to host your own private [REST based](https://github.com/microsoft/winget-cli-restsource) source.
## Building the client
@@ -98,7 +95,6 @@ We currently only build using the solution; command line methods of building a V
We would like to thank [Keivan Beigi (@kayone)](https://github.com/kayone) for his work on AppGet which helped us on the initial project direction for Windows Package Manager.
-
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
@@ -120,7 +116,7 @@ The winget.exe client is instrumented to collect usage and diagnostic (error) da
If you build the client yourself the instrumentation will not be enabled and no data will be sent to Microsoft.
-The winget.exe client respects machine wide privacy settings and users can opt-out on their device, as documented in the Microsoft Windows privacy statement [here](https://support.microsoft.com/help/4468236/diagnostics-feedback-and-privacy-in-windows-10-microsoft-privacy).
+The winget.exe client respects machine wide privacy settings and users can opt-out on their device, as documented in the Microsoft Windows privacy statement [here](https://support.microsoft.com/help/4468236/diagnostics-feedback-and-privacy-in-windows-10-microsoft-privacy). In addition, you may also explicitly block telemetry using [settings](https://docs.microsoft.com/en-us/windows/package-manager/winget/settings)
In short to opt-out, go to `Start`, then select `Settings` > `Privacy` > `Diagnostics & feedback`, and select `Basic`.
