docs: update for public repo version

Rebased repository to remove report in this version

.gitignore

@@ -13,3 +13,6 @@ dist-ssr
 !.vscode/extensions.json
 .idea
 .DS_Store
+
+# exclude project report in public repo
+docs/*

README.md

@@ -1,14 +1,21 @@
 # ![knox icon](/public/knox.svg) knox
 
-Knox is a locally hosted password manager, created for my [OCR A-level Computer Science (H446)](https://www.ocr.org.uk/qualifications/as-and-a-level/computer-science-h046-h446-from-2015/) coursework.
+Knox is a locally hosted password manager, originally created for my [OCR A-level Computer Science (H446)](https://www.ocr.org.uk/qualifications/as-and-a-level/computer-science-h046-h446-from-2015/) coursework.
+
+> [!WARNING]
+> The security of this implementation has not been audited by a third-party professional.
+> I provide the source code largely for educational purposes, and advise against using the password manager for real data.
 
 ## Documentation
 
-The design, development and testing processes are documented in the [Project Report](/docs/Project%20Report.pdf), originally authored to submit with the coursework.
+The design, development and testing processes were documented in the Project Report, originally authored to submit with the coursework.
+The report is not included in this public repo as it contains some personal information but it may be available at special request. 
 
 ## Installation
 
-On Linux and Mac systems, the installation process can be automated by running the included [bash script](/knox.sh).
+On Linux and Mac systems, most of the installation process can be automated by running the included [bash script](/knox.sh).
+
+Before running the script, PostgreSQL and Redis should be installed and configured - both of these can be set up with relative ease using docker.
 
 ```bash
 git clone https://github.com/stmio/knox.git
@@ -27,7 +34,8 @@ To start the server again in the future, simply rerun the script.
 1. Clone the repository: `git clone https://github.com/stmio/knox.git`
 2. Ensure [node>=20.0.0](https://nodejs.org/en) and npm are installed and on your path
 3. Install the required packages from Knox's base directory (`cd knox`): `npm install`
-4. Start the server:
+4. Install PostgreSQL and Redis, using docker or otherwise
+5. Start the server:
 
    - For production:
 
@@ -37,4 +45,4 @@ To start the server again in the future, simply rerun the script.
    - For development:
      - Start the dev server: `npm run dev`
 
-5. Navigate to Knox in your web browser, by default `localhost:3000`
+6. Navigate to Knox in your web browser, by default `localhost:3000`