Started creating docs

.vscode/settings.json

@@ -3,5 +3,52 @@
         "fullres",
         "gneg",
         "gunnar"
-    ]
+    ],
+    "files.exclude": {
+        "**/.git": false,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/CVS": true,
+        "**/.DS_Store": true,
+        "**/Thumbs.db": true,
+        "**/.circleci": false,
+        "**/.compodocrc*": false,
+        "**/.editorconfig": false,
+        "**/.gitattributes": false,
+        "**/.github": false,
+        "**/.gitkeep": false,
+        "**/.gitignore": false,
+        "**/.npmrc": false,
+        "**/.prettierignore": false,
+        "**/.prettierrc*": false,
+        "**/.scannerwork": false,
+        "**/.eslint*": false,
+        "**/.docker*": false,
+        "**/docker": false,
+        "**/.nvmrc": false,
+        "**/.vscodeignore": false,
+        "**/.vscode": false,
+        "**/CHANGELOG.md": false,
+        "**/README.md": false,
+        "**/LICENSE.md": false,
+        "**/angular.json": false,
+        "**/workspace.json": false,
+        "**/jest-mocks.ts": false,
+        "**/jest.config.js": false,
+        "**/jest.preset.js": false,
+        "**/node_modules": false,
+        "**/nx.json": false,
+        "**/package-lock.json": false,
+        "**/package.json": false,
+        "**/sonar-project.properties": false,
+        "**/tsconfig*": false,
+        "**/tslint*": false,
+        "**/babel*": false,
+        "**/.babel*": false,
+        "**/webpack*": false,
+        "**/typings.d.ts": false,
+        "**/*.yaml": false,
+        "**/Makefile": false,
+        "**/*.sh": false
+    }
 }

README.md

@@ -32,6 +32,9 @@ npm i -D knorry
 ```
 No additional configuration required
 
+<details>
+<summary>CDN & Node</summary>
+
 **Using a CDN (Not recommended):**
 ```javascript
 const knorry = (await import('https://cdn.jsdelivr.net/npm/knorry@latest')).default
@@ -53,6 +56,27 @@ defineKnorryOptions({
 })
 ```
 This method is not recommended because it doesn't supports all features and you aren't in need of a lightweight client in nodejs. Use a more robust client like [axios](https://npmjs.com/package/axios) instead
+</details>
+
+# Usage
+First, import all methods you need:
+```js
+import { get, post } from 'knorry'
+```
+
+Now you can make requests like this
+
+Alternatively you could use the default export:
+```js
+import knorry from 'knorry'
+knorry('POST', 'example.com', {
+    key: 'value'
+}, {
+    headers: {
+        myHeader: '12345'
+    }
+})
+```
 
 # Some things to keep in mind when using knorry
 ## Easy mode
@@ -111,3 +135,5 @@ await get('/whoami') == 'username'
 await get('/whoami') instanceof String
 !!(await get('/returns-false')).$plain() // -> false
 ```
+
+If you are working on an enterprise project, you should disable easyMode by default.

package.json

@@ -6,10 +6,11 @@
   "types": "dist/main.d.ts",
   "type": "module",
   "scripts": {
+    "docs": "typedoc --out docs --entryPointStrategy expand src",
     "test": "tsc && node test/test.js",
     "playground": "tsc && node test/endpoints.js",
     "build": "tsc && uglifyjs -o dist/main.js --compress --mangle -- dist/main.js",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build && npm run docs"
   },
   "repository": {
     "type": "git",
@@ -36,6 +37,7 @@
     "es-main": "^1.2.0",
     "express": "^4.18.2",
     "puppeteer": "^19.9.0",
+    "typedoc": "^0.24.6",
     "typescript": "^5.0.4",
     "uglify-js": "^3.17.4"
   },