From 40bdd1bf69167df5f771c7fa852143b8af60dc60 Mon Sep 17 00:00:00 2001 From: bigjakk Date: Fri, 3 Apr 2026 15:38:56 -0700 Subject: [PATCH] docs: fix heading capitalization --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 073874d..e61ccd4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [Windows (x64)](https://gitea.crjlab.net/bigjakk/Krunker-Civilian-Client/releases/latest) - [Linux (AppImage)](https://gitea.crjlab.net/bigjakk/Krunker-Civilian-Client/releases/latest) -## features +## Features - unlimited FPS with no aim freeze (custom Electron build, see [below](#custom-electron-build)) - unobtrusive — all features can be disabled, no watermarks @@ -37,7 +37,7 @@ - auto-updater - maintained & open source -## hotkeys +## Hotkeys All hotkeys are rebindable in settings. @@ -58,19 +58,19 @@ All hotkeys are rebindable in settings. | `Ctrl+Shift+T` | Reopen closed tab | | `Ctrl+1-9` | Jump to tab | -## userscripts +## Userscripts Any `.js` file in the scripts folder will be loaded as a userscript if enabled in settings. Scripts support Tampermonkey-style metadata blocks (`@name`, `@author`, `@version`, `@desc`) and can define custom settings (boolean, number, select, color, keybind). > **Use userscripts at your own risk.** Do not write or use any userscripts which would give you a competitive advantage. -## custom Electron build +## Custom Electron Build This client uses a custom-patched Electron 42 build to overcome the aim freezing issue present in modern Electron versions. The patched binary is downloaded automatically during `npm install`. For details on the patch and build instructions, see [Electron-Websocket-Fix](https://github.com/bigjakk/Electron-Websocket-Fix). -## building from source +## Building From Source 1. Install [git](https://git-scm.com/downloads), [Node.js](https://nodejs.org/), and npm 2. Clone and install: @@ -82,7 +82,7 @@ For details on the patch and build instructions, see [Electron-Websocket-Fix](ht 3. Run: `npm start` or `npm run dev` (dev mode with sourcemaps) 4. Package: `npm run dist:win` or `npm run dist:linux` -## credits +## Credits - Built on ideas from [Crankshaft](https://github.com/KraXen72/crankshaft) by KraXen72 - Inspired by [Glorp](https://github.com/slavcp/glorp) by slav