From cab1d0cb89afde727436187ca543a7248603a80f Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Fri, 28 Jun 2024 16:51:40 -0400 Subject: [PATCH 1/2] intro --- sites/docs/content/index.md | 48 +++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/sites/docs/content/index.md b/sites/docs/content/index.md index 47c10fc4..472fd20e 100644 --- a/sites/docs/content/index.md +++ b/sites/docs/content/index.md @@ -5,3 +5,51 @@ description: Runes are magic, but what good is magic if you don't have a wand? Runed is a collection of utilities for Svelte 5 that make composing powerful applications and libraries a breeze, leveraging the power of [Svelte Runes](https://svelte.dev/blog/runes). + +## Why Runed? + +Svelte 5 Runes unlock immense power by providing a set of primitives that allow us to build +impressive applications and libraries with ease. However, building complex applications often +requires more than just the primitives provided by Svelte Runes. + +Runed takes those primitives to the next level by providing: + +- **Powerful Utilities**: A set of carefully crafted utility functions and classes that simplify + common tasks and reduce boilerplate. +- **Collective Efforts**: We often find ourselves writing the same utility functions over and over + again. Runed aims to provide a single source of truth for these utilities, allowing the community + to contribute, test, and benefit from them. +- **Consistency**: We aim to provide consistent APIs and behaviors across all utilities, so you can + focus on building your projects instead of constantly learning new APIs. +- **Reactivity First**: Powered by Svelte 5's new reactivity system, Runed utilities are designed to + handle reactive state and side effects with ease. +- **Type Safety**: Full TypeScript support to catch errors early and provide a better developer + experience. + +## Ideas and Principles + +#### Embrace the Magic of Runes + +Svelte Runes are a powerful new paradigm. We believe in fully embracing this concept and exploring +its potential. Our goal is to make working with Runes feel as natural and intuitive as possible. + +#### Enhance, Don't Replace + +We're not here to replace Svelte's core functionality, but to enhance and extend it. Our utilities +should feel like a natural extension of Svelte, not a separate framework. + +#### Progressive Complexity + +Simple things should be simple, complex things should be possible. We provide easy-to-use defaults +while allowing for advanced customization when needed. + +#### Stability and Innovation + +We strive to balance stability for production use with innovation for cutting-edge development. +Breaking changes are minimized and well-communicated when necessary. + +#### Open Source and Community Collaboration + +Runed is an MIT licensed, open-source project, and we welcome contributions from the community. +Whether it's bug reports, feature requests, or code contributions, your input will help make Runed +the best it can be. From 4260da6b95ede4a742f332d16c6aac5df4bfb8aa Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sun, 30 Jun 2024 15:09:12 -0400 Subject: [PATCH 2/2] revisions --- sites/docs/content/index.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/sites/docs/content/index.md b/sites/docs/content/index.md index 472fd20e..e818a867 100644 --- a/sites/docs/content/index.md +++ b/sites/docs/content/index.md @@ -19,8 +19,8 @@ Runed takes those primitives to the next level by providing: - **Collective Efforts**: We often find ourselves writing the same utility functions over and over again. Runed aims to provide a single source of truth for these utilities, allowing the community to contribute, test, and benefit from them. -- **Consistency**: We aim to provide consistent APIs and behaviors across all utilities, so you can - focus on building your projects instead of constantly learning new APIs. +- **Consistency**: A consistent set of APIs and behaviors across all utilities, so you can focus on + building your projects instead of constantly learning new APIs. - **Reactivity First**: Powered by Svelte 5's new reactivity system, Runed utilities are designed to handle reactive state and side effects with ease. - **Type Safety**: Full TypeScript support to catch errors early and provide a better developer @@ -30,26 +30,21 @@ Runed takes those primitives to the next level by providing: #### Embrace the Magic of Runes -Svelte Runes are a powerful new paradigm. We believe in fully embracing this concept and exploring -its potential. Our goal is to make working with Runes feel as natural and intuitive as possible. +Svelte Runes are a powerful new paradigm. Runed fully embraces this concept and explores its +potential. Our goal is to make working with Runes feel as natural and intuitive as possible. #### Enhance, Don't Replace -We're not here to replace Svelte's core functionality, but to enhance and extend it. Our utilities -should feel like a natural extension of Svelte, not a separate framework. +Runed is not here to replace Svelte's core functionality, but to enhance and extend it. Our +utilities should feel like a natural extension of Svelte, not a separate framework. #### Progressive Complexity -Simple things should be simple, complex things should be possible. We provide easy-to-use defaults -while allowing for advanced customization when needed. - -#### Stability and Innovation - -We strive to balance stability for production use with innovation for cutting-edge development. -Breaking changes are minimized and well-communicated when necessary. +Simple things should be simple, complex things should be possible. Runed provides easy-to-use +defaults while allowing for advanced customization when needed. #### Open Source and Community Collaboration -Runed is an MIT licensed, open-source project, and we welcome contributions from the community. -Whether it's bug reports, feature requests, or code contributions, your input will help make Runed -the best it can be. +Runed is an open-source, MIT licensed project that welcomes all forms of contributions from the +community. Whether it's bug reports, feature requests, or code contributions, your input will help +make Runed the best it can be.