fix: update README.md

Author: yyxi

README.md

@@ -1 +1,122 @@
-# typescript-library-starter
+# @escapace/fsm
+
+Type-safe finite state machine library for TypeScript.
+
+## Features
+
+- Type-safe state machine definition and execution
+- Conditional transitions with predicates
+- Context management with reducers
+- State change subscriptions
+- High-frequency transition performance (8x faster than @xstate/fsm)
+
+## Installation
+
+```bash
+npm install @escapace/fsm
+```
+
+## Example
+
+```typescript
+import { stateMachine, interpret } from '@escapace/fsm'
+
+// Define coin values and state types
+type Coin = 5 | 10 | 25 | 50
+enum State {
+  Locked = 'LOCKED',
+  Unlocked = 'UNLOCKED',
+}
+enum Action {
+  Coin = 'COIN',
+  Push = 'PUSH',
+}
+
+// Create a turnstile that requires 50 cents to unlock
+const machine = stateMachine()
+  .state(State.Locked) // Define possible states
+  .state(State.Unlocked)
+  .initial(State.Locked) // Set starting state
+  .action<Action.Coin, { coin: Coin }>(Action.Coin) // Define action with payload type
+  .action(Action.Push) // Define action without payload
+  .context<{ total: number }>({ total: 0 }) // Set context type and initial value
+  .transition(
+    State.Locked, // From locked state
+    [
+      Action.Coin,
+      (
+        context,
+        action, // On coin insert, with predicate
+      ) => context.total + action.payload.coin >= 50,
+    ],
+    State.Unlocked, // Go to unlocked state
+    (context, action) => {
+      // Run this reducer
+      context.total += action.payload.coin
+      return context
+    },
+  )
+  .transition(
+    State.Locked, // Fallback transition when not enough coins
+    Action.Coin,
+    State.Locked,
+    (context, action) => {
+      // Add coin to total
+      context.total += action.payload.coin
+      return context
+    },
+  )
+  .transition(State.Unlocked, Action.Coin, State.Unlocked) // Stay unlocked on coin insert
+  .transition(
+    [State.Locked, State.Unlocked], // Push always locks
+    Action.Push,
+    State.Locked,
+    (context) => {
+      // Reset total on push
+      context.total = 0
+      return context
+    },
+  )
+
+// Create and use the state machine
+const turnstile = interpret(machine)
+
+console.log(turnstile.state) // 'LOCKED'
+
+turnstile.do(Action.Coin, { coin: 25 }) // Insert 25 cents
+console.log(turnstile.state) // 'LOCKED'
+
+turnstile.do(Action.Coin, { coin: 25 }) // Insert another 25 cents (total 50)
+console.log(turnstile.state) // 'UNLOCKED'
+
+turnstile.do(Action.Push) // Push through turnstile
+console.log(turnstile.state) // 'LOCKED'
+```
+
+## API
+
+### `stateMachine()`
+
+Creates a new state machine builder.
+
+#### Methods
+
+- `.state(name)` - Define a state
+- `.initial(state)` - Set initial state
+- `.action<Type, Payload>(name)` - Define an action type
+- `.context<Type>(initialValue)` - Set context type and initial value
+- `.transition(source, action, target, reducer?)` - Define state transition
+
+### `interpret(machine)`
+
+Creates an executable state machine instance.
+
+#### Properties
+
+- `.state` - Current state (readonly)
+- `.context` - Current context (readonly)
+
+#### Methods
+
+- `.do(action, payload?)` - Dispatch an action
+- `.subscribe(callback)` - Subscribe to state changes

knip.json

@@ -1,14 +1,16 @@
 {
   "$schema": "https://unpkg.com/knip@5/schema.json",
   "entry": [
-    "{scripts,perf}/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}",
     "**/*.{test,spec}.?(c|m)[jt]s?(x)",
     "**/test/**/*.?(c|m)[jt]s?(x)",
     "eslint.config.mjs",
     "src/**/example*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,vue}",
     "src/cli.ts!",
     "src/index.ts!",
-    "src/types.ts"
+    "src/types.ts",
+    "vitest.config.*.ts",
+    "vitest.config.ts",
+    "{scripts,perf}/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}"
   ],
   "ignore": ["**/*.d.+([a-zA-Z0-9]).ts", "**/*.d.ts", "lib/**"],
   "ignoreBinaries": ["ncu"],

package.json

@@ -11,14 +11,14 @@
     "@commitlint/cli": "19.8.1",
     "@commitlint/config-conventional": "19.8.1",
     "@escapace/pnpm-pack": "0.6.0",
-    "@ls-lint/ls-lint": "2.3.0",
+    "@ls-lint/ls-lint": "2.3.1",
     "@types/lodash-es": "4.17.12",
-    "@vitest/coverage-v8": "3.1.4",
+    "@vitest/coverage-v8": "3.2.2",
     "@xstate/fsm": "2.1.0",
-    "eslint": "9.27.0",
+    "eslint": "9.28.0",
     "eslint-config-escapace": "5.7.1",
     "esroll": "0.4.5",
-    "knip": "5.57.2",
+    "knip": "5.60.2",
     "lefthook": "1.11.13",
     "lodash-es": "4.17.21",
     "prettier": "3.5.3",
@@ -27,7 +27,7 @@
     "syncpack": "13.0.4",
     "tsx": "4.19.4",
     "typescript": "5.8.3",
-    "vitest": "3.1.4"
+    "vitest": "3.2.2"
   },
   "engines": {
     "pnpm": ">=10.4.1"