Skip to content

Commit c5d06b7

Browse files
committed
Update readme
1 parent a45ea5c commit c5d06b7

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
NTFY_BASE_URL=https://ntfy.sh
2+
NTFY_TOPIC= //Add your topic here

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,20 @@ A JavaFX-based chat client using [ntfy](https://docs.ntfy.sh/) for backend messa
1111
- Unit tests for `Model` class
1212
- (Advanced) Send files via "Attach local file" option
1313

14-
## 🚀 Run Instructions
15-
1. Set `JAVA_HOME` to JDK 25
14+
15+
## Requirements
16+
17+
- **Java**
18+
- **Version**: `25`
19+
20+
- **Maven Compiler Plugin**
21+
- **Version**: `3.11.0`
22+
- **Configuration**:
23+
- **Release**: `25`
24+
25+
## Usage
26+
1. Set `JAVA_HOME` to JDK 25.
27+
2. Create a **.env** file with the required variables. You can also clone and fill **.env.example** and rename it to `.env`.
1628
2. Start with:
1729
```bash
1830
./mvnw clean javafx:run

0 commit comments

Comments
 (0)