Refactor index.js to use function declarations instead of arrow functions for consistency and readability. Update README.md to clarify installation and usage instructions, removing the build section. Remove GitHub Actions release workflow as it is no longer needed.

Signed-off-by: xenos <66328734+xenos1337@users.noreply.github.com>
This commit is contained in:
xenos
2025-11-24 05:47:59 +01:00
parent f139d9c2ba
commit 30ec13fbdc
5 changed files with 102 additions and 2223 deletions
+8 -63
View File
@@ -26,64 +26,30 @@ Yes, but they most likely won't. Fixing this would require changing their entire
## Installation
1. Install dependencies:
1. Install Node.js (if not already installed)
2. Install dependencies:
```bash
npm install
```
## Building
Build standalone executables for all platforms and architectures:
```bash
npm run build
```
This creates self-contained executables in the `dist/` directory:
**Windows:**
- `httptoolkit-patcher-win-x64.exe` (64-bit)
**Linux:**
- `httptoolkit-patcher-linux-x64` (x86_64/AMD64)
- `httptoolkit-patcher-linux-arm64` (ARM64/AArch64)
**macOS:**
- `httptoolkit-patcher-macos-x64` (Intel)
- `httptoolkit-patcher-macos-arm64` (Apple Silicon M Chip)
**Note:** These are standalone executables created with `pkg` that include Node.js runtime and all dependencies. No need to install Node.js separately!
## Usage
### From Source
**Patch:**
**Patch HTTP Toolkit:**
```bash
npm start
```
**Unpatch:**
**Unpatch/Restore:**
```bash
npm run unpatch
```
### Using Prebuilt Executables
Download the appropriate executable for your platform from [Releases](https://github.com/xenos1337/httptoolkit-patcher/releases), then:
**Windows:**
```cmd
httptoolkit-patcher-win-x64.exe
```
**Linux/macOS:**
**Show help:**
```bash
chmod +x httptoolkit-patcher-linux-x64 # or your architecture
./httptoolkit-patcher-linux-x64
npm start help
```
That's it. The patcher handles everything automatically.
That's it. The patcher handles everything automatically and will request elevated permissions if needed.
## Technical Details
@@ -96,7 +62,7 @@ That's it. The patcher handles everything automatically.
## Troubleshooting
**Permission errors?** Run as admin/sudo or let the patcher request elevation.
**Permission errors?** The patcher will automatically request elevated permissions (admin/sudo).
**Already patched?** The patcher will ask if you want to repatch.
@@ -104,27 +70,6 @@ That's it. The patcher handles everything automatically.
**Anything else?** Open an issue on the [GitHub repository](https://github.com/xenos1337/httptoolkit-patcher/issues).
## GitHub Release Workflow
This project includes an automated GitHub Actions workflow that builds and releases the patcher for all platforms.
### Creating a Release
1. Create and push a version tag:
```bash
git tag v2.0.1
git push origin v2.0.1
```
2. The GitHub Actions workflow will automatically:
- Build for all platforms and architectures (Windows x64, Linux x64/ARM64, macOS Intel/Apple Silicon)
- Create standalone native executables using pkg
- Create a GitHub release with all binaries as downloadable artifacts
### Manual Workflow Trigger
You can also manually trigger the release workflow from the GitHub Actions tab.
## Disclaimer
This tool is provided as-is. Use at your own risk. For educational purposes only.