diff --git a/README.md b/README.md index a81eee0..817288a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ # TikTok-DL [![Go Report Card](https://goreportcard.com/badge/github.com/pikami/tiktok-dl)](https://goreportcard.com/report/github.com/pikami/tiktok-dl) +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pikami/tiktok-dl/tiktok-dl_CI) A simple tiktok video downloader written in go ## Basic usage -Clone this repository and run `go build` to build the executable.\ +Download the executable from `https://github.com/pikami/tiktok-dl/releases`\ You can download all videos from user by running `./tiktok-dl [Options] TIKTOK_USERNAME`\ You can download single video by running `./tiktok-dl [Options] VIDEO_URL` +## Build instructions +Clone this repository and run `go build` to build the executable. + ## Available options * `-debug` - enables debug mode * `-output some_directory` - Output path (default "./downloads") ## Acknowledgments -This software uses the chromedp for web scraping, it can be found here: https://github.com/chromedp/chromedp \ No newline at end of file +This software uses the chromedp for web scraping, it can be found here: https://github.com/chromedp/chromedp