lettersoup 1.0.0 → 1.0.2

package/README.md

@@ -2,15 +2,26 @@
 
 Algorithm for make letterSoups (sopa de letras)
 
+## Install
+
+```bash 
+  npm i lettersoup
+```
 
 ## Import/Examples
 
 ```Javascript
-import letterSoup from 'letterSoup'
+import { WordSearch } from 'letterSoup'
 
 const listWords = ['Doctor', 'Dog', 'Banana']
 
-const result = letterSoup.generate(listWords)
+const {
+      getPuzzle,
+      getWords
+    } = new WordSearch(wordsArray)
+
+const puzzle = getPuzzle()
+const words = getWords()
 ```
 
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "lettersoup",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "generate letterSoup",
-  "main": "src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "start": "ts-node -e \"require('./src/index.ts').main()\"",
+    "build": "tsc --project tsconfig.json",
     "test": "jest"
   },
   "keywords": [
@@ -22,5 +23,8 @@
     "ts-jest": "^29.2.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.3"
+  },
+  "dependencies": {
+    "npm": "^10.8.3"
   }
 }

package/tsconfig.json

@@ -26,7 +26,7 @@
 
     /* Modules */
     "module": "commonjs",                                /* Specify what module code is generated. */
-    "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "rootDir": "./src/",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
@@ -49,13 +49,13 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
     /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
     // "removeComments": true,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
@@ -104,5 +104,8 @@
     /* Completeness */
     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
     "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-  }
+  },
+  "include": [
+    "./src/"
+  ]
 }