Skip to content

Commit 7579077

Browse files
committed
Update README.md
1 parent 30fd867 commit 7579077

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,18 @@ The following arguments are available in the script's bindings:
2121
script: |
2222
"🚀 Pushed to #{context.payload.repository.name} by @#{context.actor}!
2323
```
24+
* `client`: A pre-authenticated [Tentacat][tentacat] GitHub client.
25+
It can be used like this:
26+
```yaml
27+
script: |
28+
{200, user, _} = Tentacat.Users.find(client, "gaggle")
29+
IO.puts("🤔" <> user["name"])
30+
```
31+
You can go to the [Tentacat project page][tentacat]
32+
or read [the project's Hexdocs documentation][tentacat-docs]
33+
for how to use all its features.
2434

25-
_These bindings are already defined,
26-
so you don't have to import them._
35+
_These bindings are already defined, so you don't have to import them._
2736

2837
### Outputs
2938

@@ -52,6 +61,11 @@ Elixir Script adapts its interfaces and functionality to the Elixir environment,
5261
aiming to provide a seamless experience for Elixir developers.
5362
Many thanks to the creators and contributors of GitHub Script!
5463

64+
### Tentacat
65+
66+
The GitHub library is by [Eduardo Gurgel][eduardo],
67+
huge thanks to Eduardo and contributors for making such a useful project available.
68+
5569
## Releasing
5670

5771
[New releases](https://github.com/gaggle/elixir_script/releases) are automatically created
@@ -61,6 +75,10 @@ The release must then be edited and then immediately resaved to publish it to th
6175
(This is a built-in limitation of GitHub releases
6276
that prevents Marketplace releases from being automated)
6377

78+
[eduardo]: https://github.com/edgurgel
79+
6480
[github-script]: https://github.com/marketplace/actions/github-script
6581

6682
[tentacat]: https://github.com/edgurgel/tentacat
83+
84+
[tentacat-docs]: https://hexdocs.pm/tentacat

0 commit comments

Comments
 (0)