readme

2026-02-26 15:49:05 +01:00
parent e089c32ffe
commit d2e7048100
3 changed files with 142 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,91 @@
+<p align="center"><img width="100px" src=".gitea/readme/icon.png"/></p>
+
+<h1 align="center">TimetableDesigner.Backend.Events</h1>
+
+<h3 align="center"><b>Advanced school timetable editor, allows you to easily create and manage school timetable.</b></h3>
+
+<p align="center">TimetableDesigner.Backend.Events is collection of NuGet packages (and NuGet package itself) that support communication between microservices in the TimetableDesigner project using message queues. This NuGet package contains base classes and interfaces used in other packages and in microservices itself.</p>
+
+---
+
+## Informations
+
+> [!Important]
+> **For Github users:**
+>
+> This is only mirror repository. All changes are first uploaded to the repository <a href="https://repos.mateuszskoczek.com/TimetableDesigner/TimetableDesigner.Backend.Events">here</a>. Releases are also published on original repository. However, Github repository handles issues and pull requests for better accessibility.
+
+## NuGet registry status
+
+<table>
+    <tr>
+        <th>
+            Subpackage
+        </th>
+        <th>
+            Status
+        </th>
+    </tr>
+    <tr>
+        <td>
+            <b>TimetableDesigner.Backend.Events</b>
+        </td>
+        <td>
+            <a href="https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events/"><img src="https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget"></a>
+        </td>
+    </tr>
+    <tr>
+        <th colspan=2>
+            Other subpackages
+        </th>
+    </tr>
+    <tr>
+        <td>
+            TimetableDesigner.Backend.Events.OutboxPattern
+        </td>
+        <td>
+            <a href="https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events.outboxpattern/"><img src="https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events.OutboxPattern?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            TimetableDesigner.Backend.Events.Extensions.AspNetCore.OpenApi
+        </td>
+        <td>
+            <a href="https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events.extensions.aspnetcore.openapi/"><img src="https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events.Extensions.AspNetCore.OpenApi?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            TimetableDesigner.Backend.Events.Providers.RabbitMQ
+        </td>
+        <td>
+            <a href="https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events.providers.rabbitmq/"><img src="https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events.Providers.RabbitMQ?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget"></a>
+        </td>
+    </tr>
+</table>
+
+## Installation and usage
+
+You can download package from organization package registry or .nupkg file itself from Releases tab.
+
+To download package from organization package registry, you have to add new NuGet package source. You will need access details, which you can obtain by contacting the repository owner. 
+
+**CLI:**
+
+```
+dotnet nuget add source --name TimetableDesigner --username <username> --password <password> https://repos.mateuszskoczek.com/api/packages/TimetableDesigner/nuget/index.json
+dotnet add package --source TimetableDesigner TimetableDesigner.Backend.Events
+```
+
+**Package reference in .csproj file:**
+
+```
+<PackageReference Include="TimetableDesigner.Backend.Events" Version="<version>" />
+```
+
+## Attribution and contribution
+
+This project is open source on MIT License, so you can just copy and upload again to your repository. But according to the license, you must include information about the original author. You can find license <a href="https://repos.mateuszskoczek.com/TimetableDesigner/TimetableDesigner.Backend.Events/src/branch/main/LICENSE">here</a>.
+
+However, the preferred way to contribute would be to propose improvements in a pull request, through issues, or through other means of communication.
--- a/TimetableDesigner.Backend.Events/README.md
+++ b/TimetableDesigner.Backend.Events/README.md
@@ -0,0 +1,41 @@
+# TimetableDesigner.Backend.Events
+
+### Advanced school timetable editor, allows you to easily create and manage school timetable.
+
+TimetableDesigner.Backend.Events is collection of NuGet packages (and NuGet package itself) that support communication between microservices in the TimetableDesigner project using message queues. This NuGet package contains base classes and interfaces used in other packages and in microservices itself.
+
+---
+
+## NuGet registry status
+
+| Subpackage                                                     | Status                                                                                                                                                                                                                                                                                                                                                                                                                 |
+|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **TimetableDesigner.Backend.Events**                           | [![NuGet version (TimetableDesigner.Backend.Events)](https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget)](https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events/)                                                                           |
+| TimetableDesigner.Backend.Events.OutboxPattern                 | [![NuGet version (TimetableDesigner.Backend.Events.OutboxPattern)](https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events.OutboxPattern?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget)](https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events.outboxpattern/)                                 |
+| TimetableDesigner.Backend.Events.Extensions.AspNetCore.OpenApi | [![NuGet version (TimetableDesigner.Backend.Events.OutboxPattern)](https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events.Extensions.AspNetCore.OpenApi?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget)](https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events.extensions.aspnetcore.openapi/) |
+| TimetableDesigner.Backend.Events.Extensions.AspNetCore.OpenApi | [![NuGet version (TimetableDesigner.Backend.Events.Providers.RabbitMQ)](https://img.shields.io/gitea/v/release/TimetableDesigner/TimetableDesigner.Backend.Events.Providers.RabbitMQ?gitea_url=https%3A%2F%2Frepos.mateuszskoczek.com%2F&display_name=release&label=nuget)](https://repos.mateuszskoczek.com/TimetableDesigner/-/packages/nuget/timetabledesigner.backend.events.providers.rabbitmq/)                  |
+
+## Installation and usage
+
+You can download package from organization package registry or .nupkg file itself from Releases tab.
+
+To download package from organization package registry, you have to add new NuGet package source. You will need access details, which you can obtain by contacting the repository owner. 
+
+**CLI:**
+
+```
+dotnet nuget add source --name TimetableDesigner --username <username> --password <password> https://repos.mateuszskoczek.com/api/packages/TimetableDesigner/nuget/index.json
+dotnet add package --source TimetableDesigner TimetableDesigner.Backend.Events
+```
+
+**Package reference in .csproj file:**
+
+```
+<PackageReference Include="TimetableDesigner.Backend.Events" Version="<version>" />
+```
+
+## Attribution and contribution
+
+This project is open source on MIT License, so you can just copy and upload again to your repository. But according to the license, you must include information about the original author. You can find license <a href="https://repos.mateuszskoczek.com/TimetableDesigner/TimetableDesigner.Backend.Events/src/branch/main/LICENSE">here</a>.
+
+However, the preferred way to contribute would be to propose improvements in a pull request, through issues, or through other means of communication.
--- a/TimetableDesigner.Backend.Events/TimetableDesigner.Backend.Events.csproj
+++ b/TimetableDesigner.Backend.Events/TimetableDesigner.Backend.Events.csproj
@@ -6,9 +6,13 @@
        <Nullable>enable</Nullable>
        <Title>TimetableDesigner.Backend.Events</Title>
        <Authors>Mateusz Skoczek</Authors>
-        <PackageProjectUrl>https://github.com/TimetableDesigner</PackageProjectUrl>
+        <PackageProjectUrl>https://repos.mateuszskoczek.com/TimetableDesigner</PackageProjectUrl>
        <PackageIcon>icon.png</PackageIcon>
-        <RepositoryUrl>https://github.com/TimetableDesigner/TimetableDesigner.Backend.Events</RepositoryUrl>
+        <RepositoryUrl>https://repos.mateuszskoczek.com/TimetableDesigner/TimetableDesigner.Backend.Events</RepositoryUrl>
+        <Copyright>Mateusz Skoczek</Copyright>
+        <PackageLicenseUrl>https://repos.mateuszskoczek.com/TimetableDesigner/TimetableDesigner.Backend.Events/src/branch/main/LICENSE</PackageLicenseUrl>
+        <Description>Advanced school timetable editor, allows you to easily create and manage school timetable - package that support communication between microservices in the project using message queues (base classes and interfaces)</Description>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
    </PropertyGroup>

    <ItemGroup>
@@ -21,6 +25,10 @@
        <Pack>True</Pack>
        <PackagePath></PackagePath>
      </None>
+      <None Update="README.md">
+          <Pack>True</Pack>
+          <PackagePath></PackagePath>
+      </None>
    </ItemGroup>

 </Project>