zormz 1.0.0 → 1.0.1

package/README.md

@@ -1,2 +1,174 @@
-# ZORM
-Un ORM simple pero poderoso para el uso de cualquier usuario , no te enredes con cosas como definir las tablas 
+# ZORMZ
+
+Un ORM ligero escrito en TypeScript para MySQL y PostgreSQL, diseñado para ser simple, rápido y extensible.
+
+---
+
+## Características
+
+* Compatible con **ESM** y **CommonJS**
+* Tipado completo en **TypeScript**
+* Builder con sintaxis encadenada: `select().from().where().execute()`
+* Insert múltiple con arrays
+* Soporte para MySQL y PostgreSQL
+* Sin dependencias pesadas
+* Fácil de extender
+
+---
+
+## Instalación
+
+```bash
+npm install zormz
+```
+
+---
+
+## Uso básico
+
+### Importación (ESM)
+
+```ts
+import { connecionLocal, getConexion } from "zormz";
+```
+
+### Importación (CommonJS)
+
+```js
+const { connecionLocal, getConexion } = require("zormz");
+```
+
+---
+
+##  Ejemplo: Insertar datos
+
+```ts
+const response = await DB.Insert('datosPrueba',
+  ['nombre', 'data']).Values(['yunno','magic wind']).execute();
+```
+
+Resultado esperado:
+
+```sql
+INSERT INTO datosPrueba (nombre, data) VALUES (?, ?);
+```
+
+---
+
+## Ejemplo: Select
+
+```ts
+let datos = await DB.select().from("datosPrueba").execute();
+console.log(datos);
+```
+
+---
+
+## Conexión a la base de datos
+### mysql local
+```ts
+import { connecionLocal, DB, getConexion } from "zormz";
+//de preferencia esto en el archivo raiz index.ts
+const conexion: connecionLocal = {
+  database: "pruebamaster",
+  user: "root",
+  password: "",
+  port: 3306,
+  host: "localhost",
+};
+
+getConexion("mysql", conexion);
+```
+
+---
+
+### pg en linea
+
+```ts
+const conexionPg:connecionRed = {
+  connectionString:"ruta de la conexion"
+}
+getConexion("pg",conexionPg);
+```
+---
+
+##  Métodos disponibles
+
+### **Select**
+
+* `DB.select(campos)`
+* `.from(tabla)`
+* `.where(condición, valores).execute()`
+
+### **Insert**
+
+* `DB.Insert(campos)`
+* `.valores(arrayDeValores).execute()`
+
+### **Update**
+
+* `DB.update(tabla)`
+* `.set(campos).execute()`
+
+### **Delete**
+
+* `DB.deleteFrom(tabla).where(condicionales).execute()`
+
+
+##  Ejemplo completo
+
+```ts
+import { connecionLocal, DB, eq, getConexion, ORQ } from "zormz";
+
+const conexion: connecionLocal = {
+  database: "pruebamaster",
+  user: "root",
+  password: "",
+  port: 3306,
+  host: "localhost",
+};
+
+getConexion("mysql", conexion);
+
+async function pruebaData() {
+  let datos = await DB.select().from("datosPrueba").execute();
+  console.log(datos);
+
+  let response = await DB.Insert("datosPrueba", ["nombre", "data"])
+    .Values([
+      ["yunno", "magic wind"],
+      ["astta", "no magic"],
+    ])
+    .execute();
+  console.log(response);
+
+  let update = await DB.update("datosPrueba")
+    .set({ nombre: "yukio", data: "es un juego ?" })
+    .where(eq("id", 1))
+    .execute();
+  console.log(update);
+
+  let eliminados = await DB.Delete("datosPrueba")
+    .where(ORQ("id", 3, 4, 5, 6))
+    .execute();
+  console.log(eliminados);
+}
+
+pruebaData().catch((e) => {
+  console.log("error al cargar los datos");
+});
+
+```
+
+---
+
+## 📝 Notas
+
+* Este ORM está en versión inicial.
+* Puedes extenderlo o contribuir con nuevas funciones.
+
+---
+
+## 📄 Licencia
+
+ISC © Yukio-kayaba

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "zormz",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "",
     "author": "",
     "license": "ISC",