kfg 0.0.1 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Drylian
+
+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.

package/README.md

@@ -1,15 +1,120 @@
-# test
+# K(con)fg - Simple, Type-Safe Configuration Management
 
-To install dependencies:
+[![npm version](https://badge.fury.io/js/kfg.svg)](https://badge.fury.io/js/kfg)
+[![Documentation](https://github.com/drylian/kfg/actions/workflows/docs.yml/badge.svg)](https://kfg.drylian.com/)
+
+Kfg is a robust and 100% type-safe configuration management system for Node.js and Bun applications. It provides a structured way to define, validate, and access environment variables and other configuration sources with the power of TypeScript.
+
+- ✅ **Fully Typed**: Autocomplete and type safety for all your configurations.
+- ✅ **Flexible Drivers**: Load configurations from `.env` files, JSON, or create your own driver.
+- ✅ **Built-in Validation**: Define rules and formats (email, url, etc.) directly in the schema.
+- ✅ **Smart Defaults**: Define defaults that are applied automatically.
+- ✅ **Nested Structures**: Organize your configurations logically.
+- ✅ **File-based Configuration**: Manage configurations across multiple files with `Kfg`.
+
+- ✅ **Relations**: Create one-to-one and one-to-many relations between configurations.
+
+---
+
+## 📖 Documentation
+
+- **[Full Usage Guide](https://kfg.drylian.com/)**: Learn how to install and use Kfg.
+
+## Installation
 
 ```bash
-bun install
+npm install kfg
+# or
+yarn add kfg
+# or
+bun add kfg
 ```
 
-To run:
+## Quick Example
 
-```bash
-bun run index.ts
+**1. Define your schema (`schema.ts`):**
+
+```typescript
+import { c } from "kfg";
+
+export const AppSchema = {
+  server: {
+    host: c.string({ default: "0.0.0.0" }),
+    port: c.number({ default: 3000 }),
+  },
+  database: {
+    url: c.string({ prop: "DATABASE_URL" }), // Reads from the DATABASE_URL environment variable
+  },
+};
+```
+
+**2. Create and load your instance (`config.ts`):**
+
+```typescript
+import { Kfg } from "kfg";
+import { envDriver } from "kfg/drivers";
+import { AppSchema } from "./schema";
+
+const config = new Kfg(envDriver, AppSchema);
+config.load(); // Loads values from .env and process.env
+
+export default config;
+```
+
+**3. Use it anywhere (`index.ts`):**
+
+```typescript
+import config from "./config";
+
+const port = config.get("server.port"); // Inferred as `number`
+const dbUrl = config.get("database.url"); // Inferred as `string`
+
+console.log(`Server running on port ${port}`);
+
+// Type Error! TypeScript prevents incorrect assignments.
+// config.set("server.port", "not-a-number");
+```
+
+## File-based Configuration with `Kfg`
+
+`Kfg` allows you to manage configurations across multiple files, which is useful for managing configurations for different users, tenants, or environments.
+
+**1. Define your schemas:**
+
+```typescript
+import { Kfg, c, cfs, jsonDriver } from "kfg";
+
+const inventory = new Kfg(jsonDriver, {
+    items: c.array(c.string()),
+});
+
+const user = new Kfg(jsonDriver, {
+    name: c.string(),
+    inventory_ids: cfs.many(inventory),
+});
 ```
 
-This project was created using `bun init` in bun v1.3.1. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+**2. Initialize `Kfg`:**
+
+```typescript
+inventory.init((id) => `resources/inventory/${id}.json`);
+user.init((id) => `resources/users/${id}.json`);
+```
+
+**3. Use it:**
+
+```typescript
+const user1 = user.file("user-1");
+user1.set("name", "Alice");
+
+const inv1 = inventory.file("inv-1");
+inv1.set("items", ["sword", "shield"]);
+
+user1.set("inventory_ids", [inv1]);
+
+const user1Inventories = await user1.getMany("inventory_ids");
+```
+
+## License
+
+MIT