diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6f064c3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,16 @@ +swill: Mastodon CLI. +Copyright (C) 2022 Alexander Weinhold + +Unless explicitly stated otherwise, the following applies: + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 as published by +the Free Software Foundation. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..0ca65f7 --- /dev/null +++ b/Readme.md @@ -0,0 +1,50 @@ +swill +======== + +swill is a Mastodon command line interface. + +You can find releases on [releases.gutmet.org](https://releases.gutmet.org) or +build it yourself. + +build +----- + +Check out the repository and compile with + +``` +go build -o swill +``` + + +usage +----- + +To update your status with text of any length and any number of JPGs, PNGs, GIFs, MP4s: + +``` +swill status STATUS [FILE1 FILE2 ...] +``` + +To get the timeline of a specific user: + +``` +swill timeline USERNAME +``` + + +On first use, swill swill ask you to register a new app and create an access token. Those values will be stored in HOME/.swill/ for later use. + +swill will automatically split large status messages and multiple files into separate statuses belonging to the same thread. + +Each command can use a go text template to format the printed results - pass a file name to '--template'. The template is executed with a slice of []*mastodon.Status. See go-mastodon for available data fields. + +final note +---------- + +swill does not sanitize/validate user input for now. + + +final final note +---------------- + +If you want to buy me a beer, just send inconspicuous envelopes.