Skip to content

Commit

Permalink
chore: update readme (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
huntabyte authored Feb 24, 2024
1 parent fd2d9cd commit 76b3798
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# PaneForge

<!-- automd:badges license name="paneforge" color="green" github="svecosystem/paneforge" -->

[![npm version](https://flat.badgen.net/npm/v/paneforge?color=green)](https://npmjs.com/package/paneforge)
[![npm downloads](https://flat.badgen.net/npm/dm/paneforge?color=green)](https://npmjs.com/package/paneforge)
[![license](https://flat.badgen.net/github/license/svecosystem/paneforge?color=green)](https://github.com/svecosystem/paneforge/blob/main/LICENSE)

<!-- /automd -->

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.

## Features
Expand Down Expand Up @@ -39,3 +47,16 @@ The `PaneGroup` component is used to initialize a pane group, and the `Pane` com
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.

For more information, see the [Documentation](https://paneforge.com).

## License

<!-- automd:contributors license=MIT author="huntabyte" -->

Published under the [MIT](https://github.com/svecosystem/paneforge/blob/main/LICENSE) license.
Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/svecosystem/paneforge/graphs/contributors) 💛
<br><br>
<a href="https://github.com/svecosystem/paneforge/graphs/contributors">
<img src="https://contrib.rocks/image?repo=svecosystem/paneforge" />
</a>

<!-- /automd -->
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
"description": "Monorepo for Paneforge.",
"author": "Hunter Johnston <https://github.com/huntabyte>",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/svecosystem/paneforge"
},
"scripts": {
"test": "pnpm -r test",
"dev": "pnpm sync && pnpm --parallel dev",
Expand Down
21 changes: 21 additions & 0 deletions packages/paneforge/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# PaneForge

<!-- automd:badges license name="paneforge" color="green" github="svecosystem/paneforge" -->

[![npm version](https://flat.badgen.net/npm/v/paneforge?color=green)](https://npmjs.com/package/paneforge)
[![npm downloads](https://flat.badgen.net/npm/dm/paneforge?color=green)](https://npmjs.com/package/paneforge)
[![license](https://flat.badgen.net/github/license/svecosystem/paneforge?color=green)](https://github.com/svecosystem/paneforge/blob/main/LICENSE)

<!-- /automd -->

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.

## Features
Expand Down Expand Up @@ -39,3 +47,16 @@ The `PaneGroup` component is used to initialize a pane group, and the `Pane` com
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.

For more information, see the [Documentation](https://paneforge.com).

## License

<!-- automd:contributors license=MIT author="huntabyte" -->

Published under the [MIT](https://github.com/svecosystem/paneforge/blob/main/LICENSE) license.
Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/svecosystem/paneforge/graphs/contributors) 💛
<br><br>
<a href="https://github.com/svecosystem/paneforge/graphs/contributors">
<img src="https://contrib.rocks/image?repo=svecosystem/paneforge" />
</a>

<!-- /automd -->

0 comments on commit 76b3798

Please sign in to comment.