aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 27 insertions, 6 deletions
diff --git a/README.md b/README.md
index 18000c8..ecb4a7c 100644
--- a/README.md
+++ b/README.md
@@ -294,6 +294,7 @@ ircProxy = "socks5://127.0.0.1:9050"
llmProxy = "http://127.0.0.1:8180"
skipTLSVerify = false
useTLS = true
+plugins = ["./plugins/rss.lua"]
[ircd.liberanet]
ircServer = "irc.libera.chat"
@@ -509,9 +510,9 @@ secrets:
file: ./pgadmin/pgadmin_pass
```
-The env vars `UID`and `GID`need to be defined or they can replaces by your host user's uid and gid.<br/>
+The env vars `UID` and `GID` need to be defined or they can replaces by your host user's uid and gid.<br/>
-As a convenience, there is a a [distroless](https://github.com/GoogleContainerTools/distroless) dockerfile, `Dockerfile_distroless` also provided.<br/>
+As a convenience, there is a [distroless](https://github.com/GoogleContainerTools/distroless) dockerfile, `Dockerfile_distroless` also provided.<br/>
A vendored build of milla is available by first running `go mod vendor` and then using the provided dockerfile, `Dockerfile_distroless_vendored`.<br/>
### Build
@@ -609,6 +610,30 @@ end
rss_feed()
```
+```lua
+milla.send_message(msg, target)
+```
+
+```lua
+milla.join_channel(channel)
+```
+
+```lua
+milla.part_channel(channel)
+```
+
+```lua
+milla.send_ollama_request(prompt)
+```
+
+```lua
+milla.send_gemini_request(prompt)
+```
+
+```lua
+milla.send_chatgpt_request(prompt)
+```
+
The example rss plugin, accepts a yaml file as input, reeds the provided rss feeds once, extracts the title, author name and link to the resource, sends the feed over to the `#rssfeed` irc channel and exits.<br/>
More of milla's functionality will be available through milla's lua module over time.<br/>'
@@ -641,10 +666,6 @@ Milla would not exist without the following projects:
- [ollama](https://github.com/ollama/ollama)
- [toml](https://github.com/BurntSushi/toml)
-## TODO
-
-- plugins support
-
## Similar Projects
- [soulshack](https://github.com/pkdindustries/soulshack)