@maxpeterkaya/web-proxy 1.0.1 → 1.0.3

package/INSTALL-GUIDE.md

@@ -1,8 +1,43 @@
 # How to install web-proxy
 
-## Container Middleware
+## NPM Package
+
+You can install web-proxy as a wrapper in the form of a npm package! This allows you to dynamically download the latest
+version of web-proxy at all times in your build stage without having to tweak your process to manually fetch the latest
+version through commands.
 
 ### Step 1
-In your Dockerfile
 
-## Docker Network Routing
+Install: ``npm i @maxpeterkaya/web-proxy concurrently``
+
+While running ``npm i``, it will automatically download the latest binary with execution permissions.
+
+Currently you need to run your app and web-proxy through concurrently to ensure both are running concurrently.
+
+### Step 2
+
+Add the following scripts to your package.json:
+
+```json
+{
+  "scripts": {
+    "start:proxy": "./node_modules/.bin/web-proxy",
+    "start:web": "YOUR COMMAND TO START YOUR APP",
+    "start": "concurrently --prefix none \"npm run start:web\" \"npm run start:proxy\""
+  }
+}
+```
+
+You can view the docs for concurrently [here](https://github.com/open-cli-tools/concurrently/tree/main/docs).
+
+#
+
+In the future web-proxy will be able to start your web app itself without the use of concurrently.
+
+### Step 3
+
+Simply just run ``npm run start`` and enjoy structured logs.
+
+## Container Middleware
+
+Follow the steps [here](https://github.com/maxpeterkaya/web-proxy/tree/main/examples/container-middleware).

package/README.md

@@ -12,6 +12,8 @@ Some of these frameworks may include:
 - NextJS
 - PrismaORM
 
+## [Installation Guide](https://github.com/maxpeterkaya/web-proxy/blob/main/INSTALL-GUIDE.md)
+
 ## Examples
 
 - [Container middleware](https://github.com/maxpeterkaya/web-proxy/tree/main/examples/container-middleware)

package/{install.js → bin/install.js}

@@ -25,7 +25,7 @@ if (!assetName) {
 }
 
 const url = `https://github.com/maxpeterkaya/web-proxy/releases/latest/download/web-proxy_${assetName}`;
-const destDir = path.join(__dirname, 'bin');
+const destDir = path.join(__dirname);
 const destFile = path.join(destDir, `${platform === "win32" ? "web-proxy.exe" : "web-proxy"}`);
 
 (async () => {
@@ -35,7 +35,7 @@ const destFile = path.join(destDir, `${platform === "win32" ? "web-proxy.exe" :
     const res = await fetch(url);
     if (!res.ok) throw new Error(`Failed to fetch ${url}: ${res.statusText}`);
 
-    const fileStream = fs.createWriteStream(destFile);
+    const fileStream = fs.createWriteStream(destFile, {mode: 0o755});
     await finished(Readable.fromWeb(res.body).pipe(fileStream));
 
     console.info('web-proxy installed.');

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@maxpeterkaya/web-proxy",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Server middleware enabling better logging for web apps through structured logs",
   "bin": {
     "web-proxy": "bin/run.js"
   },
   "scripts": {
-    "postinstall": "node install.js"
+    "postinstall": "node bin/install.js",
+    "start": "npx web-proxy"
   },
   "repository": {
     "type": "git",