Skip to content

Commit 96c8e61

Browse files
author
Nicholas
authored
Update README.md
1 parent ef561be commit 96c8e61

File tree

1 file changed

+35
-7
lines changed

1 file changed

+35
-7
lines changed

README.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,41 @@
1-
### LogSentry
2-
## Install
3-
Download [Python](https://www.python.org/downloads/)
1+
### LogSentry: Real-time Windows Event Log Monitoring Tool
2+
3+
LogSentry is a powerful and easy-to-use tool for monitoring Windows event logs in real-time, designed to enhance the security and management of your Windows environment.
4+
5+
## Features
6+
7+
- **Real-Time Monitoring**: LogSentry provides real-time monitoring of Windows event logs, helping you stay on top of critical events, security incidents, and system changes as they happen.
8+
9+
- **User-Friendly Interface**: LogSentry's intuitive interface and straightforward setup make it accessible to both beginners and experienced users.
10+
11+
## Installation
12+
13+
1. **Install Python**: Download and install Python from [python.org](https://www.python.org/downloads/).
14+
15+
2. **Install Dependencies**: Run the following commands to install required dependencies:
16+
`pip install asyncio` and `pip install term-image`
17+
18+
19+
4. **Clone the Repository**: Clone this repository to your local machine.
20+
`git clone https://github.com/YourUsername/LogSentry.git` and `cd LogSentry`
421

5-
Run `pip install asyncio` and `pip install term-image`
622

723
## Usage
8-
`cd LogSentry`
924

25+
Run LogSentry using the following command:
1026
`python3 main.py`
1127

12-
## Optional
13-
You can pack the project to a .exe with [PyInstaller](https://datatofish.com/executable-pyinstaller/).
28+
29+
## Advanced Usage
30+
31+
You can package LogSentry into a standalone executable (.exe) using [PyInstaller](https://datatofish.com/executable-pyinstaller/).
32+
33+
## Contributions
34+
35+
Contributions to LogSentry are welcome! Feel free to submit issues or pull requests to help improve this tool.
36+
37+
## License
38+
39+
This project is licensed under the [MIT License](https://github.com/cspi-git/LogSentry/blob/main/LICENSE).
40+
41+
**Disclaimer**: LogSentry is provided as-is and is not responsible for any unauthorized access or use of your Windows event logs. Always follow best practices for system security and data privacy.

0 commit comments

Comments
 (0)