Update README.md

README.md

@@ -8,4 +8,52 @@ pinned: false
 license: mit
 ---
 
+# Annotator YOLO PWA
+
+Prosta aplikacja PWA do oznaczania wielu obrazków prostokątami i eksportu do formatu YOLO.
+
+## Funkcje
+
+- wgrywanie wielu obrazków naraz,
+- definiowanie własnych etykiet,
+- wybór aktywnej etykiety podczas oznaczania,
+- edycja istniejących boxów: przesuwanie i zmiana rozmiaru uchwytami,
+- eksport YOLO dla bieżącego obrazka,
+- eksport całego zestawu do `images/`, `labels/`, `classes.txt`, `data.yaml`,
+- import i eksport ustawień aplikacji do pliku JSON (etykiety, aktywna etykieta, tryb, minimalny box, krok zoomu, dopasowanie po wczytaniu),
+- działanie jako PWA i obsługa offline po uruchomieniu przez localhost.
+
+## Uruchomienie
+
+```bash
+cd annotator-pwa-yolo-editor
+python -m http.server 8000
+```
+
+Następnie otwórz:
+
+```text
+http://localhost:8000
+```
+
+## Użycie
+
+1. Wgraj obrazki.
+2. Dodaj etykiety po lewej stronie.
+3. Wybierz aktywną etykietę.
+4. W trybie `Rysowanie` przeciągnij myszą po obrazie.
+5. W trybie `Zaznaczanie` kliknij box i:
+   - przeciągnij środek boxa, aby go przesunąć,
+   - przeciągnij uchwyty na krawędziach lub rogach, aby zmienić rozmiar.
+6. W panelu **Ustawienia** możesz zapisać konfigurację do pliku JSON lub wczytać ją ponownie.
+7. Eksportuj adnotacje do YOLO.
+
+## Aktualizacja PWA
+
+Jeśli przeglądarka pokazuje starszą wersję aplikacji:
+- zamknij stare karty z aplikacją,
+- odśwież stronę,
+- w Chrome możesz też wyczyścić Service Worker i pamięć witryny dla `localhost:8000`.
+
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference