more

README.md

@@ -1 +1,34 @@
 # Paneforge
+
+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
+
+-   **Simple API**: PaneForge is designed to be easy to use. It provides a small set of components that can be combined to create complex layouts.
+-   **Resizable Panes**: Panes can be resized by dragging the resizer between them.
+-   **Nested Groups**: Groups of panes can be nested inside other groups to create complex layouts.
+-   **Customizable**: The appearance and behavior of the panes can be customized using CSS and Svelte props.
+-   **Accessible**: PaneForge is designed to be accessible to all users, including those who use assistive technologies.
+-   **Community-driven**: PaneForge is an open-source project that welcomes contributions from the community. If you have an idea for a new feature or an improvement, we'd love to hear from you!
+
+## Installation
+
+```bash
+npm install paneforge
+```
+
+## Usage
+
+```svelte
+<script lang="ts">
+	import { PaneGroup, Pane, PaneResizer } from "paneforge";
+</script>
+
+<PaneGroup direction="horizontal">
+	<Pane defaultSize={50}>Pane 1</Pane>
+	<PaneResizer />
+	<Pane defaultSize={50}>Pane 2</Pane>
+</PaneGroup>
+```
+
+For more information, see the [Documentation](https://paneforge.com).

packages/paneforge/README.md

@@ -1,6 +1,15 @@
-# PaneForge
+# Paneforge
 
-Resizable pane components for Svelte.
+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
+
+- **Simple API**: PaneForge is designed to be easy to use. It provides a small set of components that can be combined to create complex layouts.
+- **Resizable Panes**: Panes can be resized by dragging the resizer between them.
+- **Nested Groups**: Groups of panes can be nested inside other groups to create complex layouts.
+- **Customizable**: The appearance and behavior of the panes can be customized using CSS and Svelte props.
+- **Accessible**: PaneForge is designed to be accessible to all users, including those who use assistive technologies.
+- **Community-driven**: PaneForge is an open-source project that welcomes contributions from the community. If you have an idea for a new feature or an improvement, we'd love to hear from you!
 
 ## Installation
 
@@ -21,3 +30,5 @@ npm install paneforge
 	<Pane defaultSize={50}>Pane 2</Pane>
 </PaneGroup>
 ```
+
+For more information, see the [Documentation](https://paneforge.com).