Skip to content

Improve README clarity and presentation #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pwgit-create merged 4 commits into from
May 26, 2026
Merged

Improve README clarity and presentation #378

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e38537e
Revise system architecture description and add links
pwgit-create May 26, 2026
8aa4904
Update README for clarity and added play button
pwgit-create May 26, 2026
a8f9528
Fix formatting in README.md
pwgit-create May 26, 2026
340e8ff
Merge pull request #377 from pwssOrg/pwgit-create-patch-2
pwgit-create May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Forum](https://github.com/orgs/pwssOrg/discussions/categories/file-integrity-sca

User-focused distribution of the Integrity Hash platform for Windows and Linux systems.

Designed for non-developers and system administrators who want a simplified installation and local file integrity monitoring experience without manually configuring backend services.
Designed for non-developers and system administrators who want a simplified installation and local file integrity monitoring experience without manually configuring backend services ▶️
<p align="center">
<a href="https://youtu.be/DcZYuQVOpCQ">
<img src="https://img.youtube.com/vi/DcZYuQVOpCQ/maxresdefault.jpg" alt="Titta på videon" width="100%" max-width="600px">
Expand All @@ -87,14 +87,14 @@ Features:

## System Architecture

The system is split into backend services, a GUI client, shared PWSS libraries, and an end-user distribution package. This modular architecture enables independent development of core security logic, user interface components, and deployment tooling for both technical and non-technical users. Each component can be developed and deployed independently while maintaining a shared security and hashing standard through the PWSS libraries.
The system is split into backend services, a GUI client, shared PWSS libraries, and a user-ready distribution package. This modular architecture enables independent development of core security logic, user interface components, and deployment tooling for both technical and non-technical users. Each component can be developed and deployed independently while maintaining a shared security and hashing standard through the PWSS libraries.

### Components

- **[Core Backend (FIM Engine)](https://github.com/pwssOrg/File-Integrity-Scanner#components)** – Handles hashing, integrity verification, and monitoring logic
- **[GUI Application](https://github.com/pwssOrg/File-Integrity-GUI#integrity-hash-java-swing-frontend)** – User interface for managing scans and viewing results
- **PWSS Libraries** – Shared components used across all PWSS projects
- **[PWSS Release Repository](https://github.com/pwssOrg/PWSS-Release-File-Integrity-Scanner#table-of-contents)** – End-user distribution for Windows and Linux
- **[PWSS Libraries](https://github.com/search?q=topic:pwss-library+org:pwssOrg&type=repositories)** – Shared components used across all PWSS projects
- **[Database Layer](https://github.com/pwssOrg/File-Integrity-Database#database-repository)** – PostgreSQL database schemas and audit infrastructure

### Architecture diagram
This repository represents the backend layer of the File Integrity Scanner system and implements the core FIM engine.
Expand Down
Loading