Skip to content

Commit 2220f99

Browse files
authored
Update README.md
1 parent 2c9fdd9 commit 2220f99

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Top toolbar contains 4 tabs
3434
If you think that tool displays to you wrong information for example it displays persistent calls that does not exist anymore or not displaying some call that it should (see [Limitations](#limitations)) you can re-scan your project via `Tools => UnityEventTracker => Scan Project`.
3535

3636
## Event Highlighting
37-
Highlights [Target Objects](#target-object). If all persistent calls are valid object highlighted in `green`![Green](https://via.placeholder.com/15/00ff00/000000?text=+). If al least one of persistent call is in invalid state object highlighted in `red`. ![Red](https://via.placeholder.com/15/ff0000/000000?text=+)
37+
Highlights [Target Objects](#target-object). If all persistent calls are valid, object highlighted in `green`![Green](https://via.placeholder.com/15/00ff00/000000?text=+). If at least one of persistent call is invalid, object highlighted in `red`. ![Red](https://via.placeholder.com/15/ff0000/000000?text=+)
3838

3939
![Highlighting](.github/Media/Highlighting.PNG)
4040

@@ -58,5 +58,8 @@ Currently UnityEvent declared in plain C# classes are not tracked. I'm plannig t
5858
In the example below `UnityEvent` SOEvent declated in `TestSOEventClass` is tracked by this tool, but `UnityEvent` EventInPlainCSharpClass declared in `PlainCSharpClass` is not tracked.
5959

6060
![Example](.github/Media/UntrackedEventExample.PNG)
61+
6162
# Bug Report
62-
If you faced some bug, please open a new [Issue](https://github.com/ApxfIy/UnityEventTracker/issues) so I can improve this tool
63+
64+
This tool creates log files at `Assets/Plugins/UnityEventTrasker/Logs` if it failed to scan some asset. Please, note, that log files contains full YAML representation of asset (scene, prefab or SO) that failed to be scanned. This representation might contains some private information (API keys, passwords etc.) so you might want to delete it from log file before sending them. After sending the logs you should delete them.
65+
If you faced some bug/error, please open a new [Issue](https://github.com/ApxfIy/UnityEventTracker/issues) so I can improve this tool.

0 commit comments

Comments
 (0)