Docs don't match the reality

[dgoemans]

Describe the bug

Just installed localtunnels in a project on Node 20, Windows 11

A file was added in the .bin folder as localtunnel (not localtunnels as the docs describe).
When attempting to execute ./localtunnels start i am told that the binary does not exist
When attempting to execute ./localtunnel start it simply opens the cli.js file in my IDE.
When following the instructions to run it within my codebase using startLocalTunnel, my application crashes (I'm running my application locally with ts-node).

Basically, none of the documented methods to run the application currently work for me.

Reproduction

Installed localtunnels in a project on Node 20, Windows 11. Attempt to use it as per the documentation.

System Info

System:
    OS: Windows 11 10.0.26100
    CPU: (16) x64 AMD Ryzen 7 7840U w/ Radeon  780M Graphics
    Memory: 7.05 GB / 27.81 GB
  Binaries:
    Node: 20.16.0 - C:\Program Files\nodejs\node.EXE
    Yarn: 3.6.4 - C:\Program Files\nodejs\yarn.CMD
    npm: 10.8.1 - C:\Program Files\nodejs\npm.CMD
    pnpm: 9.15.4 - C:\Program Files\nodejs\pnpm.CMD
  Browsers:
    Edge: Chromium (128.0.2739.42)
    Internet Explorer: 11.0.26100.1882

Used Package Manager

npm

Validations

• Follow our Code of Conduct
• Read the Contributing Guide.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
• The provided reproduction is a minimal reproducible of the bug.

[chrisbbreuer]

Super sorry about this! I should be mentioning this better in the readme, but this is a major WIP still. Once I get the cloud component abstracted in here, so one can easily spin up their own server, I will create a proper release that matches what the readme and the docs mention.

The docs will also be elaborated quite a bit here