diff --git a/README.md b/README.md index b4c8407..f575653 100644 --- a/README.md +++ b/README.md @@ -1,160 +1,35 @@ - - -
- - -Willkommen zum Telegram-Bot! Hier ist eine einfache Anleitung, wie du die Funktionen des Bots nutzen kannst:
- -/wunsch
Beschreibung: Verwende diesen Befehl, um einen Wunsch zu äußern.
-Schritt: Der Bot wird dir eine Liste von Kategorien anzeigen, aus denen du auswählen kannst.
- -Der Bot zeigt dir ein Inline-Keyboard mit verschiedenen Kategorien wie Film, Serie, Anime, etc. Wähle eine Kategorie aus, die zu deinem Wunsch passt.
- -Der Bot wird dich fragen, ob du einen Link zum Wunsch hinzufügen möchtest (z.B. zu einem Cover oder Spotify). Falls du keinen Link hinzufügen möchtest, kannst du einfach „X“ eingeben.
- -Gib den Titel des Wunsches ein, den du äußern möchtest.
- -Der Bot sendet deinen Wunsch an die Gruppe, und du erhältst eine Bestätigung.
-Befehl: Diese Funktion ist nur für Admins verfügbar.
-Beschreibung: Admins können einen Wunsch als erfüllt markieren, wenn der Wunsch umgesetzt wurde.
- -Befehl: Diese Funktion ist nur für Admins verfügbar.
-Beschreibung: Admins können Wünsche als „Nicht gefunden“ markieren, wenn der Wunsch nicht gefunden wurde.
- -Befehl: /notfound
Beschreibung: Zeigt eine Liste aller nicht gefundenen Wünsche an. Nur Admins können diesen Befehl verwenden.
- -Beschreibung: Admins können nicht gefundene Wünsche aus der Liste löschen. Der Bot wird nach der Nummer des Eintrags fragen, den du löschen möchtest.
-.env Datei:
--TELEGRAM_TOKEN="TOKEN" -ALLOWED_CHAT_ID="CHAT-ID" -ALLOWED_THREAD_ID="Channel wo der Bot arbeiten kann (Beispiel 3)" --
zu Installierende Pakete:
-npm install telegraf
npm install path
npm install fs
npm install archiver
npm install
node-schedule
npm install dotenv
📝 Bot-Nutzeranleitung
Willkommen zum Telegram-Bot! Hier ist eine einfache Anleitung, wie du die Funktionen des Bots nutzen kannst:
1. Wunsch äußern
Wunsch-Befehl verwenden
Befehl: /wunsch:
+
Beschreibung:
Verwende diesen Befehl, um einen Wunsch zu äußern.
Schritt: Der Bot wird dir eine Liste von Kategorien anzeigen, aus denen du auswählen kannst.
Kategorie auswählen
Der Bot zeigt dir ein Inline-Keyboard mit verschiedenen Kategorien wie Film, Serie, Anime, etc.
Wähle eine Kategorie aus, die zu deinem Wunsch passt.
Link hinzufügen (Optional)
Der Bot wird dich fragen, ob du einen Link zum Wunsch hinzufügen möchtest (z.B. zu einem Cover oder Spotify).
Falls du keinen Link hinzufügen möchtest, kannst du einfach „X“ eingeben.
Titel des Wunsches eingeben
Gib den Titel des Wunsches ein, den du äußern möchtest.
Bestätigen
Der Bot sendet deinen Wunsch an die Gruppe, und du erhältst eine Bestätigung.
2. Wunsch als erfüllt markieren
Befehl: Diese Funktion ist nur für Admins verfügbar.
Beschreibung: Admins können einen Wunsch als erfüllt markieren, wenn der Wunsch umgesetzt wurde.
3. Wunsch als „Nicht gefunden“ markieren
Befehl: Diese Funktion ist nur für Admins verfügbar.
Beschreibung: Admins können Wünsche als „Nicht gefunden“ markieren, wenn der Wunsch nicht gefunden wurde.
4. Nicht gefundene Wünsche verwalten
Nicht gefundene Wünsche anzeigen
Befehl: /notfound
Beschreibung: Zeigt eine Liste aller nicht gefundenen Wünsche an. Nur Admins können diesen Befehl verwenden.
Nicht gefundene Wünsche löschen
Beschreibung: Admins können nicht gefundene Wünsche aus der Liste löschen. Der Bot wird nach der Nummer des Eintrags fragen, den du löschen möchtest.
+
+
# folgende Daten müssen beim ersten Start hinterlegt werden
.env Datei:
TELEGRAM_TOKEN="TOKEN"
ALLOWED_CHAT_ID="CHAT-ID"
ALLOWED_THREAD_ID="Channel wo der Bot arbeiten kann (Beispiel 3)"
zu Installierende Pakete:
npm install telegraf
npm install path
npm install fs
npm install archiver
npm install
node-schedule
npm install dotenv