From 17380d0720dd05b9026576bc1fcd9f93890896e4 Mon Sep 17 00:00:00 2001 From: Bernd Hufmann Date: Fri, 24 Sep 2021 13:42:56 -0400 Subject: [PATCH] Update README.md to describe the published NPM packages Signed-off-by: Bernd Hufmann --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f33107045..1f7a82405 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,13 @@ Prerequisites: A GitHub account (for logging into Gitpod) ## Consume the trace viewer extension from npm -We plan to distribute this extension on npm. +The **theia-trace-extension** project publishes the following packages to NPM: -Availability: TBD +* [theia-traceviewer](https://www.npmjs.com/package/theia-traceviewer): The Theia trace viewer extension. Add this package to the package.json of your Theia application. +* [traceviewer-base](https://www.npmjs.com/package/traceviewer-base): This package contains trace management utilities for managing traces using Trace Server applications that implement the TSP. +* [traceviewer-react-components](https://www.npmjs.com/package/traceviewer-components): This package contains views and utilities for visualizing traces and logs via the TSP connected to a Trace Server application. + +While being initially used within the *theia-traceviewer*, the code base of *traceviewer-base* and *traceviewer-react-components* is independent to any Theia APIs and hence can be integrated in other web applications. ## Build the extension and example application