klaim 1.0.0 → 1.0.1

package/README.md

@@ -1,15 +1,67 @@
-# klaim
+# Klaim 📦
 
-To install dependencies:
+Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user
+experience.
 
-```bash
-bun install
+## 🚀 Features
+
+- **Efficient API Management**: Easily manage multiple APIs with streamlined integration and interaction capabilities.
+- **Request Recording**: Seamlessly track requests for debugging and monitoring.
+- **User Experience Optimization**: Focused on performance and usability for a smooth user experience.
+- **Lightweight**: Minimal footprint for fast load times and minimal performance impact.
+- **TypeScript Support**: Fully typed for enhanced code quality and developer experience.
+
+## 📥 Installation
+
+Install Klaim via npm:
+
+```sh
+// Using npm
+npm install klaim
+
+// Using bun
+bun add klaim
 ```
 
-To run:
+## 🛠 Usage
+
+Here’s a basic example to get you started:
+
+```typescript
+import {Api, Klaim, Registry, Route} from 'klaim';
 
-```bash
-bun run index.ts
+// Your simple Todo type
+type Todo = {
+    userId: number;
+    id: number;
+    title: string;
+    completed: boolean;
+}
+
+// --- Basic API configuration
+// Create a new API with the name "hello" and the base URL "https://jsonplaceholder.typicode.com/"
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Define routes for the API
+    Route.get<Todo[]>("listTodos", "todos");
+
+    // You can also define routes with parameters
+    Route.get<Todo>("getTodo", "todos/[id]");
+
+    // You can also define routes in post, (put, delete, etc)
+    Route.post<Todo>("addTodo", "todos");
+});
+
+// --- Usage
+// Make a request to the "listTodos" route
+const listOfTodos = await Klaim.hello.todo<Todo>({id: 1})
+
+// Make a request to the "getTodo" route with the parameter "id"
+const todo = await Klaim.hello.getTodo<Todo>({id: 1})
+
+// Make a request to the "addTodo" route
+const newTodo = await Klaim.hello.addTodo<Todo>({}, {title: "New Todo", completed: false, userId: 1})
 ```
 
-This project was created using `bun init` in bun v1.1.17. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+## 🤝 Contributing
+
+Contributions are welcome!

package/package.json

@@ -1,7 +1,26 @@
 {
     "name": "klaim",
+    "description": "Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user experience.",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/antharuu/klaim.git"
+    },
+    "keywords": [
+        "typescript",
+        "api",
+        "request",
+        "user experience",
+        "optimization",
+        "lightweight"
+    ],
+    "author": "antharuu",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/antharuu/klaim/issues"
+    },
+    "homepage": "https://github.com/antharuu/klaim#readme",
     "type": "module",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "main": "dist/klaim.cjs.js",
     "module": "dist/klaim.es.js",
     "types": "dist/index.d.ts",