dockview-react 4.13.1 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,22 +1,22 @@
1
1
  <div align="center">
2
- <h1>dockview</h1>
2
+ <h1>dockview-react</h1>
3
3
 
4
- <p>Zero dependency layout manager supporting tabs, groups, grids and splitviews. Supports React, Vue and Vanilla TypeScript</p>
4
+ <p>Re-export wrapper for the <code>dockview</code> package use <code>dockview</code> directly for new projects</p>
5
5
 
6
6
  </div>
7
7
 
8
8
  ---
9
9
 
10
- [![npm version](https://badge.fury.io/js/dockview.svg)](https://www.npmjs.com/package/dockview)
11
- [![npm](https://img.shields.io/npm/dm/dockview)](https://www.npmjs.com/package/dockview)
10
+ [![npm version](https://badge.fury.io/js/dockview-react.svg)](https://www.npmjs.com/package/dockview-react)
11
+ [![npm](https://img.shields.io/npm/dm/dockview-react)](https://www.npmjs.com/package/dockview-react)
12
12
  [![CI Build](https://github.com/mathuo/dockview/workflows/CI/badge.svg)](https://github.com/mathuo/dockview/actions?query=workflow%3ACI)
13
13
  [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=coverage)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
14
14
  [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=alert_status)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
15
- [![Bundle Phobia](https://badgen.net/bundlephobia/minzip/dockview)](https://bundlephobia.com/result?p=dockview)
15
+ [![Bundle Phobia](https://badgen.net/bundlephobia/minzip/dockview-react)](https://bundlephobia.com/result?p=dockview-react)
16
16
 
17
17
  ##
18
18
 
19
- ![](packages/docs/static/img/splashscreen.gif)
19
+ ![](https://github.com/mathuo/dockview/blob/HEAD/packages/docs/static/img/splashscreen.gif?raw=true)
20
20
 
21
21
  Please see the website: https://dockview.dev
22
22
 
@@ -33,6 +33,22 @@ Please see the website: https://dockview.dev
33
33
  - High test coverage
34
34
  - Documentation website with live examples
35
35
  - Transparent builds and Code Analysis
36
- - Security at mind - verifed publishing and builds through GitHub Actions
36
+ - Security at mind - verified publishing and builds through GitHub Actions
37
37
 
38
- Want to verify our builds? Go [here](https://www.npmjs.com/package/dockview#Provenance).
38
+ ## Quick Start
39
+
40
+ This package re-exports everything from [`dockview`](https://www.npmjs.com/package/dockview). For new projects, we recommend installing `dockview` directly:
41
+
42
+ ```
43
+ npm install dockview
44
+ ```
45
+
46
+ If you're already using `dockview-react`, it continues to work — all exports are identical to `dockview`:
47
+
48
+ ```
49
+ npm install dockview-react
50
+ ```
51
+
52
+ See the [`dockview` package](https://www.npmjs.com/package/dockview) and the [documentation](https://dockview.dev) for usage examples.
53
+
54
+ Want to verify our builds? Go [here](https://www.npmjs.com/package/dockview-react#Provenance).