gsadmin/KoalaSync
1
0
Fork 0
mirror of https://github.com/Shik3i/KoalaSync.git synced 2026-07-26 12:08:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: complete audit of all READMEs for consistency

Browse Source
This commit is contained in:
MacBook
2026-05-04 04:46:27 +02:00
parent c9ec6ce3e0
commit 5440d136fe
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/README.md
+2 -1
View File
@@ -34,5 +34,6 @@ npm start
## Security
- **Rate Limiting**: IP-based connection limits and socket-based event limits.
- **Token Handshake**: Requires a valid token defined in `shared/constants.js`.
- **Token Handshake**: Requires a valid token defined in the root `shared/constants.js`.
- **Single Source of Truth**: The server imports constants directly from the root `shared/` directory.
- **In-Memory**: Rooms are automatically pruned after 2 hours of inactivity.
shared/README.md
+1 -1
View File
@@ -4,7 +4,7 @@ This directory contains constants and protocol definitions used by both the exte
## Syncing with the Extension
> [!IMPORTANT]
> Every time this file is modified, you must run `scripts/sync-constants.sh` to keep the extension's copy up to date.
> Every time this file is modified, you must run `node scripts/build-extension.js` to keep the extension's copy up to date.
Because Chrome Extensions cannot load files outside their root directory, `constants.js` must be copied to `extension/shared/constants.js` whenever it is modified.