Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #7

Merged
merged 1 commit into from
Feb 24, 2024
Merged

chore: update readme #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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 -->
Loading