Skip to content

Commit 18c6f52

Browse files
authored
Update README.md
1 parent c4d22a9 commit 18c6f52

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## Overview
77
This repository contains the implementation of a C JNI Agent designed to recursively capture the values of objects within methods on a stack trace.
88

9-
![dashboard](DISSERTATION/dashboard-app.png)
9+
![design](DISSERTATION/end-design.png)
1010

1111
## Prerequisites
1212
To utilize this agent, you need to install the following libraries:
@@ -19,7 +19,7 @@ To utilize this agent, you need to install the following libraries:
1919
Compile the JNI agent and generate the library files.
2020

2121
2. **Running with Java**:
22-
Incorporate the resulting library files using the `-agentpath` flag in the Java command.
22+
Incorporate the resulting library files using the Java command's `-agentpath` flag.
2323

2424
## Scala Spray Server Integration
2525
This agent interfaces with a basic Scala Spray server to record captured values in MongoDB.
@@ -29,16 +29,19 @@ This agent interfaces with a basic Scala Spray server to record captured values
2929
- Build and run the server using `sbt run`.
3030

3131
## FuelPHP Dashboard
32-
A FuelPHP dashboard is used to display the analysis results by communicating with the Scala Spray server.
32+
33+
![dashboard](DISSERTATION/dashboard-app.png)
34+
35+
A FuelPHP dashboard displays the analysis results by communicating with the Scala Spray server.
3336

3437
### Setup
3538
- Perform `composer install` to set up the FuelPHP dashboard.
3639

3740
## Note
38-
This implementation serves as a Minimum Viable Product (MVP). It is not stable, secure, or optimized. However, relevant code snippets, especially those demonstrating communication with the JNI, can be extracted and used.
41+
This implementation serves as a Minimum Viable Product (MVP). It is not stable, secure, or optimized. However, relevant code snippets can be extracted and used, especially those demonstrating communication with the JNI.
3942

4043
## Disclaimer
41-
This was academic research and no guarantees or maintenance are provided.
44+
This was academic research, and no guarantees or maintenance are provided.
4245

4346
# Cite
4447

0 commit comments

Comments
 (0)