Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lifailon committed May 20, 2024
1 parent dda628b commit d4b0bfe
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# <img src="https://github.com/Lifailon/WinAPI/blob/rsa/Screen/ico/x128.png" width="25" /> WinAPI

[![GitHub Release](https://img.shields.io/github/v/release/Lifailon/WinAPI?display_name=release&logo=GitHub&label=GitHub&link=https%3A%2F%2Fgithub.com%2FLifailon%2FWinAPI%2F)](https://github.com/Lifailon/WinAPI)
[![NuGet Version](https://img.shields.io/nuget/v/ps.win.api?logo=NuGet&label=NuGet&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2Fps.win.api)](https://www.nuget.org/packages/ps.win.api)
[![GitHub top language](https://img.shields.io/github/languages/top/Lifailon/WinAPI?logo=PowerShell&link=https%3A%2F%2Fgithub.com%2FPowerShell%2FPowerShell)](https://github.com/PowerShell/PowerShell)
[![GitHub License](https://img.shields.io/github/license/Lifailon/WinAPI?link=https%3A%2F%2Fgithub.com%2FLifailon%2FWinAPI%2Fblob%2Frsa%2FLICENSE)](https://github.com/Lifailon/WinAPI/blob/rsa/LICENSE)
<h1 align="center">
<img src="https://github.com/Lifailon/WinAPI/blob/rsa/Screen/ico/x128.png" width="30" />
WinAPI
</h1>

<p align="center">
<a href="https://github.com/Lifailon/WinAPI"><img title="GitHub Release"src="https://img.shields.io/github/v/release/Lifailon/WinAPI?display_name=release&logo=GitHub&label=GitHub&link=https%3A%2F%2Fgithub.com%2FLifailon%2FWinAPI%2F"></a>
<a href="https://www.nuget.org/packages/ps.win.api"><img title="NuGet Version"src="https://img.shields.io/nuget/v/ps.win.api?logo=NuGet&label=NuGet&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2Fps.win.api"></a>
<a href="https://github.com/Lifailon/WinAPI"><img title="GitHub top language"src="https://img.shields.io/github/languages/top/Lifailon/WinAPI?logo=PowerShell&link=https%3A%2F%2Fgithub.com%2FPowerShell%2FPowerShell"></a>
<a href="https://github.com/Lifailon/WinAPI/blob/rsa/LICENSE"><img title="GitHub License"src="https://img.shields.io/github/license/Lifailon/WinAPI?link=https%3A%2F%2Fgithub.com%2FLifailon%2FWinAPI%2Fblob%2Frsa%2FLICENSE"></a>
</p>

**📝 Publication on [Habr](https://habr.com/ru/articles/783022/)**

Expand All @@ -13,12 +18,15 @@ REST API and Web server on base **.NET HttpListener** and backend only **PowerSh

**🔗 Implemented**:

- [✅ Frontend web interface](#-implemented-endpoints)
- [✅ Viewing and filtering Windows events](#-viewing-and-filtering-windows-events)
- [✅ More than 20 unique endpoints](#-implemented-endpoints)
- [✅ Authentication](#-authorization)
- [✅ Converting to 4 data types](#-change-data-type)
- [✅ Response codes handling](#-response-code)
- [✅ Converting to 4 data types](#-change-data-type)
- [✅ Error handling](#-operational-stability)
- [✅ Control module](#-module)
- [✅ Logging](#-server-log)

🍿 The server functionality is implemented in the [Kinozal-Bot](https://github.com/Lifailon/Kinozal-Bot) project.

Expand All @@ -40,10 +48,6 @@ REST API and Web server on base **.NET HttpListener** and backend only **PowerSh

![Image alt](https://github.com/Lifailon/WinAPI/blob/rsa/Screen/Web/Web-Service.jpg)

- Viewer and filtering event:

![Image alt](https://github.com/Lifailon/WinAPI/blob/rsa/Screen/Web/Web-Event.gif)

- Hardware statistics:

![Image alt](https://github.com/Lifailon/WinAPI/blob/rsa/Screen/Web/Web-Hardware.jpg)
Expand All @@ -58,6 +62,10 @@ To give you an example, a file download from the Internet was taking place on a

![Image alt](https://github.com/Lifailon/WinAPI/blob/rsa/Screen/Web/Web-Sensors.jpg)

## 📄 Viewing and filtering Windows events

![Image alt](https://github.com/Lifailon/WinAPI/blob/rsa/Screen/Web/Web-Event.gif)

## 📚 Implemented endpoints

All GET requests can be output in one of the following formats: **JSON (default), HTML, XML, CSV**. When using a browser for GET requests, by default the response is processed in table format using HTML markup.
Expand Down

0 comments on commit d4b0bfe

Please sign in to comment.