Added README.md

This commit is contained in:
Pijus Kamandulis 2019-06-01 20:36:48 +03:00
parent 12e6b93520
commit 3f15dade4c

15
README.md Normal file
View File

@ -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