Skip to content

Commit

Permalink
Updated README.md and added screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
mrusme committed Apr 4, 2021
1 parent 3fe966d commit 9b73ea8
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 13 deletions.
143 changes: 130 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,21 @@ client.
## Description

Gomphotherium is a Mastodon client for the command line, offering a CLI as well
as a TUI with a usage similar to [rainbowstream](rainbowstream).
as a TUI with a usage similar to [rainbowstream](rainbowstream). It is intended
to be used at 80 characters width maximum, but ideally inside [tmux][tmux] as
a sidebar-style program.

![Gomphotherium](gomphotherium.png)

[rainbowstream]: https://github.com/orakaro/rainbowstream
[tmux]: https://github.com/tmux/tmux


## Installation

Download a binary from the [releases][releases] page. MacOS, Linux, Windows,
FreeBSD, and OpenBSD binaries are available.
Download a binary from the [releases][releases] page.

Or just build it yourself (requires Go 1.16+):
Or build it yourself (requires Go 1.16+):

```bash
make
Expand All @@ -39,11 +43,6 @@ gomphotherium authenticate https://YOUR-MASTODON-SERVER-URL-HERE.com
```


### CLI

TODO


### TUI

Launch the TUI with the following command:
Expand Down Expand Up @@ -75,15 +74,133 @@ the Mastodon instance.

##### Shortcuts

`Ctrl+Q`: Quit Gomphotherium
`Ctrl` + `Q` \
Quit Gomphotherium

`Ctrl+R`: Refresh timeline
`Ctrl` + `R` \
Refresh timeline

`i`: Enter **Command** mode (while in **Normal** mode)
`:` \
Enter **Command** mode (while in **Normal** mode)

`Esc`: Leave **Command** mode (while in **Command** mode)
`Esc` \
Leave **Command** mode (while in **Command** mode)


##### Commands

`home` \
`local` \
`public` \
`notifications` \
Switch between timelines

`t`*` content ...`* \
`toot`*` content ...`* \
Publish a new public toot

`tp`*` content ...`* \
`tootprivate`*` content ...`* \
Publish a new private toot

`tu`*` content ...`* \
`tootunlisted`*` content ...`* \
Publish a new unlisted toot

`td`*` content ...`* \
`tootdirect`*` content ...`* \
Publish a new direct toot

`re`*` toot-id content ...`* \
`reply`*` toot-id content ...`* \
Reply to a toot publicly

`rep`*` toot-id content ...`* \
`replyprivate`*` toot-id content ...`* \
Reply to a toot privately

`reu`*` toot-id content ...`* \
`replyunlisted`*` toot-id content ...`* \
Reply to a toot unlisted

`red`*` toot-id content ...`* \
`replydirect`*` toot-id content ...`* \
Reply to a toot directly

`rt`*` toot-id`* \
`retoot`*` toot-id`* \
`boost`*` toot-id`* \
Boost a toot

`ut`*` toot-id`* \
`unretoot`*` toot-id`* \
`unboost`*` toot-id`* \
Undo boosting a toot

`fav`*` toot-id`* \
Fav a toot

`unfav`*` toot-id`* \
Undo fav-ing a toot

`open`*` toot-id`* \
Open toot in system browser

`share`*` toot-id`* \
Copy toot URL to the clipboard

`help` \
`?` \
Show help page

`quit` \
`exit` \
`bye` \
Quit Gomphotherium

**Info:** \
- `content ...` describes the text content of a toot, including
[inline shortcodes](#inline-shortcodes)
_ `toot-id` describes the toot ID (number) visible on the right side of each
toot in the timeline

##### Inline Shortcodes

Inline shortcodes allow to add additional info to toots. They can be added
anywhere in the toot content as they get filtered from the toot before
publishing.

`~!!` \
Mark toot as sensitive; one-time shortcode

`~#[`*`text ...`*`]` \
Add content warning (spoiler) text to toot; one-time shortcode

`~:[`*`/path/to/file`*`]` \
Add media by file path to toot; can be specified multiple times


##### Usage Examples

`t Hello World!` \
Publish a new public toot that says *Hello World!*

`tp Mondays are fine. It’s your life that sucks. ~#[Controversial joke]` \
Publish a new private toot that says *Mondays are fine. It’s your life that
sucks.* with a content warning that says *Controversial joke*

`tu Check out my mustache! ~:[/home/user/Photos/awesome_mustache.jpg] ~!!` \
Publish a new unlisted toot with a photo attached to it, that is flagged
sensitive

`re 11 I think so, @brain, but aren't we out of shaving cream?` \
Publicly reply to toot with ID *11* with *I think so, @brain, but aren't we out
of shaving cream?*

`rt 11` \
Retoot/boost toot with ID *11*


### CLI

TODO
Binary file added gomphotherium.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9b73ea8

Please sign in to comment.