Skip to content

Commit 76b3798

Browse files
authored
chore: update readme (#7)
1 parent fd2d9cd commit 76b3798

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# PaneForge
22

3+
<!-- automd:badges license name="paneforge" color="green" github="svecosystem/paneforge" -->
4+
5+
[![npm version](https://flat.badgen.net/npm/v/paneforge?color=green)](https://npmjs.com/package/paneforge)
6+
[![npm downloads](https://flat.badgen.net/npm/dm/paneforge?color=green)](https://npmjs.com/package/paneforge)
7+
[![license](https://flat.badgen.net/github/license/svecosystem/paneforge?color=green)](https://github.com/svecosystem/paneforge/blob/main/LICENSE)
8+
9+
<!-- /automd -->
10+
311
PaneForge provides components that make it easy to create resizable panes in your Svelte apps. It's designed to be simple to use, and to work well with other Svelte components and libraries. This project has taken a lot of inspiration and code from the work done by [Bryan Vaughn](https://github.com/bvaughn) and [react-resizable-panels](https://github.com/bvaughn/react-resizable-panels) and seeks to provide a similar experience for Svelte developers.
412

513
## Features
@@ -39,3 +47,16 @@ The `PaneGroup` component is used to initialize a pane group, and the `Pane` com
3947
The components ship only with the styles necessary to position the panes in the appropriate layout. The rest of the styling is up to you.
4048

4149
For more information, see the [Documentation](https://paneforge.com).
50+
51+
## License
52+
53+
<!-- automd:contributors license=MIT author="huntabyte" -->
54+
55+
Published under the [MIT](https://github.com/svecosystem/paneforge/blob/main/LICENSE) license.
56+
Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/svecosystem/paneforge/graphs/contributors) 💛
57+
<br><br>
58+
<a href="https://github.com/svecosystem/paneforge/graphs/contributors">
59+
<img src="https://contrib.rocks/image?repo=svecosystem/paneforge" />
60+
</a>
61+
62+
<!-- /automd -->

package.json

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
"description": "Monorepo for Paneforge.",
66
"author": "Hunter Johnston <https://github.com/huntabyte>",
77
"main": "index.js",
8+
"repository": {
9+
"type": "git",
10+
"url": "https://github.com/svecosystem/paneforge"
11+
},
812
"scripts": {
913
"test": "pnpm -r test",
1014
"dev": "pnpm sync && pnpm --parallel dev",

packages/paneforge/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# PaneForge
22

3+
<!-- automd:badges license name="paneforge" color="green" github="svecosystem/paneforge" -->
4+
5+
[![npm version](https://flat.badgen.net/npm/v/paneforge?color=green)](https://npmjs.com/package/paneforge)
6+
[![npm downloads](https://flat.badgen.net/npm/dm/paneforge?color=green)](https://npmjs.com/package/paneforge)
7+
[![license](https://flat.badgen.net/github/license/svecosystem/paneforge?color=green)](https://github.com/svecosystem/paneforge/blob/main/LICENSE)
8+
9+
<!-- /automd -->
10+
311
PaneForge provides components that make it easy to create resizable panes in your Svelte apps. It's designed to be simple to use, and to work well with other Svelte components and libraries. This project has taken a lot of inspiration and code from the work done by [Bryan Vaughn](https://github.com/bvaughn) and [react-resizable-panels](https://github.com/bvaughn/react-resizable-panels) and seeks to provide a similar experience for Svelte developers.
412

513
## Features
@@ -39,3 +47,16 @@ The `PaneGroup` component is used to initialize a pane group, and the `Pane` com
3947
The components ship only with the styles necessary to position the panes in the appropriate layout. The rest of the styling is up to you.
4048

4149
For more information, see the [Documentation](https://paneforge.com).
50+
51+
## License
52+
53+
<!-- automd:contributors license=MIT author="huntabyte" -->
54+
55+
Published under the [MIT](https://github.com/svecosystem/paneforge/blob/main/LICENSE) license.
56+
Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/svecosystem/paneforge/graphs/contributors) 💛
57+
<br><br>
58+
<a href="https://github.com/svecosystem/paneforge/graphs/contributors">
59+
<img src="https://contrib.rocks/image?repo=svecosystem/paneforge" />
60+
</a>
61+
62+
<!-- /automd -->

0 commit comments

Comments
 (0)