readme

svecosystem · Mar 11, 2024 · c3c9fbf · c3c9fbf
1 parent 66cfe5d
commit c3c9fbf
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -8,46 +8,18 @@
 
 <!-- /automd -->
 
-WithRunes 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.
+WithRunes provides utilities to power your applications using the magic of [Svelte Runes](https://svelte.dev/blog/runes).
 
 ## Features
 
-- **Simple API**: WithRunes 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.
-- **Persistent Layouts**: WithRunes can be used with LocalStorage or cookies to persist the layout of the panes between page loads.
-- **Accessible**: WithRunes is designed to be accessible to all users, including those who use assistive technologies.
-- **Community-driven**: WithRunes 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!
+<!-- TODO -->
 
 ## Installation
 
 ```bash
 npm install withrunes
 ```
 
-## Basic Usage
-
-Here's a simple example of how to use WithRunes to create a horizontal pane group with two panes:
-
-```svelte
-<script lang="ts">
-	import { PaneGroup, Pane, PaneResizer } from "withrunes";
-</script>
-
-<PaneGroup direction="horizontal">
-	<Pane defaultSize={50}>Pane 1</Pane>
-	<PaneResizer />
-	<Pane defaultSize={50}>Pane 2</Pane>
-</PaneGroup>
-```
-
-The `PaneGroup` component is used to initialize a pane group, and the `Pane` component is used to create a pane. The `PaneResizer` component is used to create a resizer that can be dragged to resize the panes.
-
-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://withrunes.com).
-
 ## Sponsors
 
 This project is supported by the following beautiful people/organizations:
@@ -63,7 +35,7 @@ This project is supported by the following beautiful people/organizations:
 <!-- automd:contributors license=MIT author="huntabyte" -->
 
 Published under the [MIT](https://github.com/svecosystem/withrunes/blob/main/LICENSE) license.
-Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/svecosystem/withrunes/graphs/contributors) 💛
+Made by [@TGlide](https://github.com/tglide), [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/svecosystem/withrunes/graphs/contributors) 💛
 <br><br>
 <a href="https://github.com/svecosystem/withrunes/graphs/contributors">
 <img src="https://contrib.rocks/image?repo=svecosystem/withrunes" />

diff --git a/packages/withrunes/README.md b/packages/withrunes/README.md
@@ -8,46 +8,18 @@
 
 <!-- /automd -->
 
-WithRunes 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.
+WithRunes provides utilities to power your applications using the magic of [Svelte Runes](https://svelte.dev/blog/runes).
 
 ## Features
 
-- **Simple API**: WithRunes 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.
-- **Persistent Layouts**: WithRunes can be used with LocalStorage or cookies to persist the layout of the panes between page loads.
-- **Accessible**: WithRunes is designed to be accessible to all users, including those who use assistive technologies.
-- **Community-driven**: WithRunes 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!
+<!-- TODO -->
 
 ## Installation
 
 ```bash
 npm install withrunes
 ```
 
-## Basic Usage
-
-Here's a simple example of how to use WithRunes to create a horizontal pane group with two panes:
-
-```svelte
-<script lang="ts">
-	import { PaneGroup, Pane, PaneResizer } from "withrunes";
-</script>
-
-<PaneGroup direction="horizontal">
-	<Pane defaultSize={50}>Pane 1</Pane>
-	<PaneResizer />
-	<Pane defaultSize={50}>Pane 2</Pane>
-</PaneGroup>
-```
-
-The `PaneGroup` component is used to initialize a pane group, and the `Pane` component is used to create a pane. The `PaneResizer` component is used to create a resizer that can be dragged to resize the panes.
-
-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://withrunes.com).
-
 ## License
 
 <!-- automd:contributors license=MIT author="huntabyte" -->