From dd8a648a3e2f8c8e48ebb249e10ba6bd562d0922 Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Sun, 12 Mar 2023 21:45:30 +0800 Subject: [PATCH] chore: readme file --- packages/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/README.md b/packages/README.md index b6d61140e..7543f83de 100644 --- a/packages/README.md +++ b/packages/README.md @@ -1,5 +1,7 @@ # Project Structure +This mono-repository has a number of packages containing the code for the [dockview](https://www.npmjs.com/package/dockview) library and the documentation website [dockview.dev](dockview.dev). + ## dockview-core - Contains the core logic for the dockview library. @@ -9,8 +11,8 @@ - Depends on `dockview-core`. - Exports a `React` wrapper. -- Published `dockview` package. +- Published as [dockview](https://www.npmjs.com/package/dockview) on npm. ## docs -- Code for website found at [dockview.dev](dockview.dev). +- Code for [dockview.dev](dockview.dev).