Skip to content

Commit 57a440c

Browse files
committed
Update README
- line length - correct url to tools.plat.soy/pleroma-access-token - lessen pleroma-specific language - remove link to nonexistent wiki
1 parent 2b29379 commit 57a440c

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Confirmed working with:
1313
- Pleroma
1414

1515
gof is for "go feediverse", "go fediverse", "go fedi", or really
16-
whatever you want. gof is a port of [feediverse][feediverse] written in
17-
Go.
16+
whatever you want. gof started as a port of [feediverse][feediverse],
17+
written in Go.
1818

1919
gof supports multiple feeds and multiple accounts.
2020

@@ -49,10 +49,11 @@ cp gof.example.yaml gof.yaml
4949
vim gof.yaml # don't forget to edit it!
5050
```
5151

52-
You'll need an access token as well. You can get on from the [Fediverse
53-
Instance Access Token Generator][fediverse-access-token].
52+
You'll need an access token as well. On Mastodon you can get some from
53+
your settings page, and for others without a PAT UI, you can get on from
54+
the [Fediverse Instance Access Token Generator][fediverse-access-token].
5455

55-
[fediverse-access-token]:https://tools.splat.soy/fediverse-access-token/
56+
[fediverse-access-token]:https://tools.splat.soy/pleroma-access-token/
5657

5758
Then you can use it:
5859

@@ -68,8 +69,8 @@ line:
6869
```
6970

7071
This would allow you to place the executable (and configuration)
71-
anywhere on your system. Once gof is configured, you might want to add it to
72-
your crontab, or your other favorite task scheduler:
72+
anywhere on your system. Once gof is configured, you might want to add
73+
it to your crontab, or your other favorite task scheduler:
7374

7475
```text
7576
*/30 * * * * cd /path/to/$REPO; gof
@@ -99,10 +100,11 @@ template: |-
99100
{{.URL}}
100101
```
101102
102-
### Pleroma instances
103+
### Instances supporting formatted posts
103104
104105
Formatted posts are also supported. You can choose from plaintext,
105-
Markdown, HTML, or BBCode, as long as they’re supported by your instance.
106+
Markdown, HTML, or BBCode, as long as they’re supported by your
107+
instance. Here's an example with Markdown:
106108
107109
```yaml
108110
template: |-
@@ -113,7 +115,3 @@ template: |-
113115
{{.URL}}
114116
format: markdown
115117
```
116-
117-
See configuration details [in the wiki][wiki-formatting].
118-
119-
[wiki-formatting]:https://github.com/prplecake/gof/wiki/Configuration-Options#template

0 commit comments

Comments
 (0)