@j0u1/finity 0.0.1 → 0.0.2

package/README.md

@@ -1,15 +1,51 @@
-# finity
+# @j0u1/finity
 
-To install dependencies:
+[![npm](https://img.shields.io/npm/v/@j0u1/finity)](https://www.npmjs.com/package/@j0u1/finity)
+
+Lightweight finite state machine (FSM) library for TypeScript.
+
+## Install
 
 ```bash
-bun install
+bun add @j0u1/finity
+# or
+npm install @j0u1/finity
 ```
 
-To run:
+## Usage
 
-```bash
-bun run index.ts
+```ts
+import { createMachine } from "@j0u1/finity"
+
+const traffic = createMachine({
+  initial: "red",
+  transitions: {
+    red: "yellow",
+    yellow: "green",
+    green: "yellow",
+  },
+})
+
+traffic.current   // "red"
+traffic.next()    // "yellow"
+traffic.current   // "yellow"
+traffic.can("green")  // true
+traffic.can("red")    // false
 ```
 
-This project was created using `bun init` in bun v1.3.13. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## API
+
+### `createMachine(config)`
+
+Creates a new state machine.
+
+| Parameter | Type | Description |
+|---|---|---|
+| `config.initial` | `string` | Initial state |
+| `config.transitions` | `Record<string, string>` | Map of state transitions |
+
+Returns an object with:
+
+- **`current`** — current state
+- **`next()`** — transitions to the next state, returns new state. Throws if no transition exists.
+- **`can(state)`** — returns `true` if transition to given state is possible from current state

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@j0u1/finity",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "module": "index.ts",
   "main": "./dist/index.js",
   "type": "module",
   "scripts": {
     "build": "bun build ./index.ts --outdir ./dist --format esm --packages external"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/j0u1/finity"
+  },
   "devDependencies": {
     "@types/bun": "latest"
   },
   "peerDependencies": {
     "typescript": "^5"
   }
-}
+}