Skip to content

Commit 679f34b

Browse files
authored
Update README.md
1 parent b89d91c commit 679f34b

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ machine.
1919
- SHA-3 (256-bit)
2020
- BLAKE_2b (512-bit)
2121

22-
- **Web Interface / GUI:** A Spring application with a user-friendly web interface where you can start and stop
23-
scans, as well as get live information about the current integrity status of your files.
24-
25-
- **Database Storage:** Uses PostgreSQL to store file hashes along with the date of the scan and other relevant
26-
file metadata.
22+
- **Database Storage:** Uses PostgreSQL to store file hashes along with the date of the scan and other relevant file metadata.
2723

2824
- **Local Operation:** The scanner runs exclusively on the user's local machine. No remote services are required
2925
or desired, ensuring full control over data integrity for the end-user.
@@ -48,12 +44,14 @@ or desired, ensuring full control over data integrity for the end-user.
4844

4945
### Steps
5046

51-
1. Ensure you have PostgreSQL and Spring installed on your system.
52-
2. Access the database script from the dedicated PWSS repository.
53-
3. Use provided Make scripts to start both the database and Spring application.
47+
1. Install and configure PostgreSQL on your system.
48+
2. Get the database scripts from the [PWSS DB repository](https://github.com/pwssOrg/File-Integrity-Database).
49+
3. Start the database and the Spring application using the provided Make scripts.
50+
51+
**Note:** You need access to the PWSS libraries, which consist of three separate PWSS repositories hosted in a private GitHub Packages registry. Access is restricted to board members or team members of the PWSS organization.
52+
For links to all three JavaDoc pages, please refer to the discussion thread:
53+
**[Java Docs](https://github.com/orgs/pwssOrg/discussions/308)**
5454

55-
**Note:** You need access to the PWSS libraries stored in a private GitHub packages repository, which is
56-
restricted to board members or team members of the PWSS organization.
5755

5856
## Workflow Badges
5957

0 commit comments

Comments
 (0)