diff --git a/README.md b/README.md index beff84a..ddc22cf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # 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) + + + 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 @@ -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 + + + +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) 💛 +

+ + + + + diff --git a/package.json b/package.json index c458134..c5a5b8b 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,10 @@ "description": "Monorepo for Paneforge.", "author": "Hunter Johnston ", "main": "index.js", + "repository": { + "type": "git", + "url": "https://github.com/svecosystem/paneforge" + }, "scripts": { "test": "pnpm -r test", "dev": "pnpm sync && pnpm --parallel dev", diff --git a/packages/paneforge/README.md b/packages/paneforge/README.md index 1dd6336..14842e7 100644 --- a/packages/paneforge/README.md +++ b/packages/paneforge/README.md @@ -1,5 +1,13 @@ # 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) + + + 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 @@ -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 + + + +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) 💛 +

+ + + + +