diff --git a/README.md b/README.md index 55f200bd..c95b3e68 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,32 @@ -# Microsoft ServiceHub / Service Broker +# vs-ServiceHub + +[![Build Status](https://dev.azure.com/azure-public/vside/_apis/build/status/vs-servicehub?branchName=main)](https://dev.azure.com/azure-public/vside/_build/latest?definitionId=53&branchName=main) + +These are the libraries that Visual Studio uses for much of its intra- and inter-process exchange of services. + +## Microsoft.ServiceHub.Framework [![NuGet package](https://img.shields.io/nuget/v/Microsoft.ServiceHub.Framework.svg)](https://nuget.org/packages/Microsoft.ServiceHub.Framework) + +[Learn more about this package](src/Microsoft.ServiceHub.Framework/README.md). + +## @microsoft/servicehub-framework + [![NPM package](https://img.shields.io/npm/v/@microsoft/servicehub-framework)](https://www.npmjs.com/package/@microsoft/servicehub-framework) -[![Build Status](https://dev.azure.com/azure-public/vside/_apis/build/status/vs-servicehub?branchName=main)](https://dev.azure.com/azure-public/vside/_build/latest?definitionId=53&branchName=main) +[Learn more about this package](src/servicebroker-npm/README.md). + +## Microsoft.ServiceHub.Framework.Testing + +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.ServiceHub.Framework.Testing.svg)](https://nuget.org/packages/Microsoft.ServiceHub.Framework.Testing) + +[Learn more about this package](src/Microsoft.ServiceHub.Framework.Testing/README.md). + +## Microsoft.ServiceHub.Analyzers + +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.ServiceHub.Analyzers.svg)](https://nuget.org/packages/Microsoft.ServiceHub.Analyzers) -These are the libraries that Visual Studio use for much of its intra- and inter-process exchange of services. +[Learn more about this package](src/Microsoft.ServiceHub.Analyzers/README.md). ## Contributing @@ -15,4 +36,4 @@ See our [contributing doc](CONTRIBUTING.md) for more info. ## Notices -Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies. +Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. diff --git a/src/Microsoft.ServiceHub.Analyzers/README.md b/src/Microsoft.ServiceHub.Analyzers/README.md new file mode 100644 index 00000000..067bfc0f --- /dev/null +++ b/src/Microsoft.ServiceHub.Analyzers/README.md @@ -0,0 +1,8 @@ +# Microsoft.ServiceHub.Analyzers + +This package contains the static analyzers to guide code that consumes [the Microsoft.ServiceHub.Framework package](https://nuget.org/packages/Microsoft.ServiceHub.Framework). + +Analyzer ID | Description +--|-- +ISB001 | Dispose of proxies +ISB002 | Avoid storing rentals in fields diff --git a/src/Microsoft.ServiceHub.Framework.Testing/README.md b/src/Microsoft.ServiceHub.Framework.Testing/README.md new file mode 100644 index 00000000..eb2f6e52 --- /dev/null +++ b/src/Microsoft.ServiceHub.Framework.Testing/README.md @@ -0,0 +1,3 @@ +# Microsoft.ServiceHub.Framework.Testing + +A library that can assist in testing brokered service contracts. diff --git a/src/Microsoft.ServiceHub.Framework/README.md b/src/Microsoft.ServiceHub.Framework/README.md new file mode 100644 index 00000000..22e41667 --- /dev/null +++ b/src/Microsoft.ServiceHub.Framework/README.md @@ -0,0 +1,6 @@ +# Microsoft.ServiceHub.Framework + +This package contains the APIs necessary to proffer and consume [brokered services](https://learn.microsoft.com/visualstudio/extensibility/internals/brokered-service-essentials?view=vs-2022). + +It includes infrastructure for in-proc brokered service sharing as well as sharing across processes on the same machine and user account over named pipes. +Other transports are also supported, provided they provide a duplex pipe.