Skip to content

Commit 8d9024b

Browse files
committed
Update READMME
1 parent 2262ded commit 8d9024b

File tree

1 file changed

+38
-4
lines changed

1 file changed

+38
-4
lines changed

README.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,36 @@ the example:
2525

2626
```
2727
$ cd $REPO
28-
$ cp config.yaml.example config.yaml
29-
$ vim config.yaml # don't forget to edit it!
28+
$ cp gof.yaml.example gof.yaml
29+
$ vim gof.yaml # don't forget to edit it!
3030
```
3131

32-
You'll need an access token as well. The configuration will be saved in
33-
`$REPO/gof.yaml`:
32+
You'll need an access token as well. You can get on from the [Pleroma
33+
Access Token Generator][pleroma-access-token].
34+
35+
[pleroma-access-token]:https://tools.splat.soy/pleroma-access-token/
36+
37+
Build the thing:
3438

3539
```
3640
$ go build
41+
```
42+
43+
Then you can use it:
44+
45+
```
3746
$ ./gof
3847
```
3948

49+
You could also specify the configuration file to use via the command
50+
line:
51+
52+
```
53+
$ ./gof -c /path/to/your/gof.yaml
54+
```
55+
56+
This would allow you to place the executable (and configuration)
57+
anywhere on your system.
4058
Once gof is configured, you might want to add it to your crontab:
4159

4260
```
@@ -69,6 +87,22 @@ template: |-
6987
{{.URL}}
7088
```
7189
90+
Formatted posts are also supported. You can choose from plaintext,
91+
Markdown, HTML, or BBCode, as long as they’re supported by your Pleroma
92+
instance.
93+
94+
```yaml
95+
template: |-
96+
**{{.Title}}**
97+
98+
{{.URL}}
99+
format: markdown
100+
```
101+
102+
See configuration details [in the wiki][wiki-formatting].
103+
104+
[wiki-formatting]:https://man.sr.ht/~mjorgensen/gof/configuration.md#format
105+
72106
## resources
73107
74108
Discussion and patches are welcome and should be directed to my public

0 commit comments

Comments
 (0)