From a08a132b9bc5097d010cd21a3d423fd1c3c293f3 Mon Sep 17 00:00:00 2001 From: "Kevin Larkin (MS)" Date: Mon, 18 May 2020 19:00:56 -0700 Subject: [PATCH] Update README.md (#173) * Update README.md --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 53617cb2d8..3b136dbcd4 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,19 @@ You can also [build the client yourself](#building-the-client). While the client [![Build Status](https://dev.azure.com/ms/winget-cli/_apis/build/status/microsoft.winget-cli?branchName=master)](https://dev.azure.com/ms/winget-cli/_build/latest?definitionId=344&branchName=master) -## Overview +## Windows Package Manager 1.0 Roadmap +The plan for delivering Windows Package Manager v1.0 [is described here](doc/windows-package-manager-v1-roadmap.md), and will be updated as the project proceeds. -Our goal with the Windows Package Manager is to make your development process on Windows easier, faster, and more efficient. The goal isn't to be *the* package manager you use, but we do want to have all of the functionality to be a choice. And if you want to use a different package manager, we at least want to be able to provide you with a simple, quick command to bootstrap you into your preferred experience. +## 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 ``` -Although we are calling it a package manager because the term fits semantically, we don't actually manage what one would traditionally call a 'package'. Windows aleady has such a package manager; the MSIX deployment architecture is built around declarative, bundled packages that can cleanly be added and removed. However, there are many programs that have been written for Windows that are not in an MSIX package. We want to be able to manage these for you as well (as best we can). +For Preview, the goal is to get something usable in your hands as soon as possible. At preview you can **search**, **show**, and **install** packages. Soon we will have **uninstall**, **list** and **update**. These items are available on our [backlog](https://github.com/microsoft/winget-cli/issues), so feel free to upvote the features you want. -For Preview, the goal is to get something usable in your hands as soon as possible. That means that right now we have the infrastructure to support install. From here, we have plenty of backlog features in our [Issues](https://github.com/microsoft/winget-cli/issues). You can upvote the ones you want, add more, or even [get started on one](https://github.com/microsoft/winget-cli/projects/1). +## Overview + +### Client Repository +This winget-cli repository includes the source code designed to build the client. You are encouraged to participate in the development of this client. We have plenty of backlog features in our [Issues](https://github.com/microsoft/winget-cli/issues). You can upvote the ones you want, add more, or even [get started on one.](https://github.com/microsoft/winget-cli/projects/1) ### Sources The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retreive the metadata about the packages, so that the client can act on it. @@ -47,6 +53,10 @@ The default source reflects that data available from the [Community repo](https: 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](https://github.com/microsoft/winget-cli/docs/spec/YamlSpec.md) for spec compliance. + + ## Building the client ### Prerequisites