From 3f15dade4c8d86ba3f7d08e001a25036370cf94e Mon Sep 17 00:00:00 2001 From: Pijus Kamandulis Date: Sat, 1 Jun 2019 20:36:48 +0300 Subject: [PATCH] Added README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..927987e --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# RSS-DL + +[![Go Report Card](https://goreportcard.com/badge/github.com/pikami/rss-dl)](https://goreportcard.com/report/github.com/pikami/rss-dl) + +A simple rss feed downloader written in go + +## Basic usage +Clone this repository and run `go build` to build the executable.\ +You can download feeds by running `./rss-dl [Options] FEED_URL` + +## Available options +* `-output some_directory` - Output path (default ".") + +## Acknowledgments +This software uses the gofeed parser which can be found here: https://github.com/mmcdole/gofeed