foldkit 0.13.0-canary.1 → 0.13.0-canary.2

package/README.md

@@ -1,11 +1,23 @@
 # Foldkit
 
-> ⚠️ **Experimental**: Foldkit is in canary release for early adopters and experimenters. APIs are incomplete and may change rapidly.
+> ⚠️ Foldkit is in canary release for early adopters and experimenters. APIs are incomplete and may change rapidly.
 
-**Foldkit** is an [Elm](https://elm-lang.org/)-inspired UI framework powered by [Effect](https://effect.website/).
+**Foldkit** is an [Elm](https://elm-lang.org/)-inspired framework for building web applications powered by [Effect](https://effect.website/).
 
 > Like origami: simple parts become intricate when folded together.
 
+---
+
+## Philosophy
+
+Foldkit applies functional programming principles to web application development.
+
+- **Pure updates** — State transitions are deterministic functions: `(model: Model, message: Message): Model` is the only way to change state.
+- **Controlled side effects** — Side effects are described as `Command<Message>` values and executed by the runtime, not performed directly in update functions.
+- **Explicit state transitions** — Every state change is modeled as a specific message type and is captured in the update function.
+
+---
+
 ## Installation
 
 The best way to get started with Foldkit is to use `create-foldkit-app`. This
@@ -16,12 +28,16 @@ package manager and example template.
 npx create-foldkit-app@latest --wizard
 ```
 
-## Counter Example
+---
+
+### Simple Counter Example
+
+See the full example at [examples/counter/src/main.ts](examples/counter/src/main.ts)
 
 ```ts
 import { Match as M, Schema } from 'effect'
 import { Runtime } from 'foldkit'
-import { Class, Html, OnClick, button, div } from 'foldkit/html'
+import { Html, html } from 'foldkit/html'
 import { ts } from 'foldkit/schema'
 
 // MODEL
@@ -41,13 +57,13 @@ type Decrement = typeof Decrement.Type
 type Increment = typeof Increment.Type
 type Reset = typeof Reset.Type
 
-type Message = typeof Message.Type
+export type Message = typeof Message.Type
 
 // UPDATE
 
-const update = (count: Model, message: Message): [Model, Runtime.Command<Message>[]] =>
+const update = (count: Model, message: Message): [Model, ReadonlyArray<Runtime.Command<Message>>] =>
   M.value(message).pipe(
-    M.withReturnType<[Model, Runtime.Command<Message>[]]>(),
+    M.withReturnType<[Model, ReadonlyArray<Runtime.Command<Message>>]>(),
     M.tagsExhaustive({
       Decrement: () => [count - 1, []],
       Increment: () => [count + 1, []],
@@ -61,6 +77,8 @@ const init: Runtime.ElementInit<Model, Message> = () => [0, []]
 
 // VIEW
 
+const { div, button, Class, OnClick } = html<Message>()
+
 const view = (count: Model): Html =>
   div(
     [Class('min-h-screen bg-white flex flex-col items-center justify-center gap-6 p-6')],
@@ -96,4 +114,40 @@ Runtime.run(element)
 
 ---
 
-**📚 Full documentation and examples**: https://github.com/devinjameson/foldkit
+## Development
+
+Explore the examples locally:
+
+```bash
+git clone https://github.com/devinjameson/foldkit.git
+cd foldkit
+pnpm install
+
+# In one terminal - build Foldkit in watch mode
+pnpm dev:core
+
+# In another terminal - run the counter example
+pnpm dev:example:counter
+```
+
+---
+
+## Status
+
+We're building in the open. Feedback, issues, and contributions are welcome.
+
+---
+
+## Roadmap
+
+- [x] Core program loop with ADT-based update
+- [x] DOM rendering
+- [x] Optimized DOM rendering (minimal diffs, efficient updates)
+- [x] Router integration
+- [ ] Devtools + tracing
+
+---
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foldkit",
-  "version": "0.13.0-canary.1",
+  "version": "0.13.0-canary.2",
   "description": "Elm-inspired UI framework powered by Effect",
   "type": "module",
   "main": "./dist/index.js",
@@ -47,12 +47,18 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "clean": "rimraf dist *.tsbuildinfo",
+    "build": "pnpm run clean && tsc -b",
+    "watch": "tsc -b --watch",
+    "typecheck": "tsc -b --noEmit"
+  },
   "peerDependencies": {
     "effect": "^3.18.2"
   },
   "devDependencies": {
-    "effect": "^3.18.2",
-    "typescript": "^5.4.0"
+    "effect": "^3.19.14",
+    "typescript": "^5.9.3"
   },
   "keywords": [
     "effect",
@@ -69,19 +75,13 @@
     "directory": "packages/foldkit"
   },
   "dependencies": {
-    "@effect/platform-browser": "^0.72.0",
-    "snabbdom": "^3.6.2"
+    "@effect/platform-browser": "^0.74.0",
+    "snabbdom": "^3.6.3"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
     "node": ">=18.0.0"
-  },
-  "scripts": {
-    "clean": "rimraf dist *.tsbuildinfo",
-    "build": "pnpm run clean && tsc -b",
-    "watch": "tsc -b --watch",
-    "typecheck": "tsc -b --noEmit"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Devin Jameson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.