Updated the README.md

This commit is contained in:
mathias 2021-10-04 18:16:55 +02:00
parent 8d14d4284b
commit 7a4ce77c8a
No known key found for this signature in database
GPG Key ID: 8950DF62139C852A

View File

@ -18,6 +18,10 @@
An unofficial java integration for the AutoResponder App. Use it to create a more professional and complex bot An unofficial java integration for the AutoResponder App. Use it to create a more professional and complex bot
## Setup guide
If you want to set this up in the AutoResponder app, you need to follow our [setup guide](SETUP.md)
### Installation ### Installation
1. Add the jitpack repository to your `pom.xml` 1. Add the jitpack repository to your `pom.xml`
@ -43,7 +47,7 @@ An unofficial java integration for the AutoResponder App. Use it to create a mor
#### 1. Creating a new auto responder instance #### 1. Creating a new auto responder instance
```java ```java
SimpleAutoResponder autoResponder=new SimpleAutoResponder(); SimpleAutoResponder autoResponder = new SimpleAutoResponder();
``` ```
#### 2. Setting up the responder #### 2. Setting up the responder
@ -91,8 +95,8 @@ DialogflowIntegration class.
```java ```java
DialogflowIntegration integration=new DialogflowIntegration(new File("your_credentials_file.json")); DialogflowIntegration integration=new DialogflowIntegration(new File("your_credentials_file.json"));
integration.setLanguageCode("de"); // Here you can set the language of the integration integration.setLanguageCode("de"); // Here you can set the language of the integration
integration.getMessage("My message","The sender of the message / a session id for better training"); integration.getMessage("My message","The sender of the message / a session id for better training");
``` ```
#### 5. Listeners #### 5. Listeners
@ -107,6 +111,10 @@ This project also supports commands. That means that you create your own custom
sent us the command. You can use the `ResponderGroupCommand` or the `ResponderChatCommand` to handle those commands. If sent us the command. You can use the `ResponderGroupCommand` or the `ResponderChatCommand` to handle those commands. If
you want to learn more, check out the [CommandExample](src/examples/java/CommandExample.java) you want to learn more, check out the [CommandExample](src/examples/java/CommandExample.java)
#### 7. Secondary use
You use the AutoResponder app as main place of your rules, any you only want to react to all commands? No problem. Just
create a new rule and set your command prefix before the "*". The responder will thn only react if the message is a command
## Other examples ## Other examples
You can find some other examples in the [examples directory](src/examples/java). You can find some other examples in the [examples directory](src/examples/java).