aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf6509b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+Fetch tweets from a set of profiles and turn them into RSS feeds.
+
+```
+$ go run main.go -h
+
+ -o string
+ Directory where RSS files will be dropped (default ".")
+ -q string
+ Comma-separated list of '<@user_name>:<user_id>' values.
+```
+
+In order to make this work, you need to provide an API token bearer, and pass it
+into the `PIUPIU_TOKEN` environment variable.
+
+## License
+
+```txt
+Copyright (C) 2026-Ω Miquel Sabaté Solà <mssola@mssola.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+```