Merge pull request #1 from CIRFMF/readme-update

Update README.md

Author: mjakmf

README.md

@@ -1 +1,48 @@
-# SDK ksef 2.0 
+# **KSeF**
+
+
+## Wstęp – Struktura projektu i technologie
+
+Projekt składa się z dwóch modułów:
+- **demo-web-app** – przykładowa aplikacja webowa (spring boot), która używa SDK i rozszerza o przykładowe użycia czy scenariusze testowe.
+- **ksef-client** – biblioteka (SDK), zawierająca wspólną logikę, modele oraz interfejsy.
+
+Całość napisana jest w języku **Java**. Do komunikacji HTTP wykorzystywany jest java.net.http.HttpClient.
+
+
+## 🔧 Wersje technologii
+| Komponent      | Java | Spring Boot |
+|----------------|------|-------------|
+| `ksef-client`  | 11   | –           |
+| `demo-web-app` | 21   | 3.3.0       |
+
+---
+
+### Struktura katalogów ksef-client
+
+
+- **api**  
+  Zawiera buildery do tworzenia requestów do API oraz serwisy wspomagające generowanie certyfikatów, kryptograficzny czy sam klient http który realizuje żądania HTTP do API.
+
+- **client**  
+  Zawiera modele klas odpowiadających zwrotkom z API, definicje wyjątków, interfejsy oraz modele.
+
+
+
+### Struktura katalogów demo-web-app
+
+- **integrationTest**  
+  Zawiera przykładowe scenariusze testowe.
+
+- **api**  
+  Zawiera przykładowe rest kontrolery, które wywołują bezpośrednio ksef clienta.
+
+
+
+
+## Zawartość repozytorium
+
+- Przykładowa aplikacja
+- Implementacja klienta KSeF 2.0
+- Przykłady użycia i integracji z KSeF 2.0
+