Initial commit

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c112585
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# metube
+
+metube is a program for searching youtube and extracting video information such as the title, channel, url, length...
+
+It uses [ytparser](https://git.sr.ht/~ark/ytparser) under the hood.
+
+## Usage
+
+	metube [options] search_term
+	  -f string
+			The format to print items in. Follows go template syntax. See metube(5) for more info. (default "channel: {{.ChannelTitle}}, title: {{.Title}}, url: {{.Url}}")
+	  -l string
+			The language to search in (follows youtube's language codes: en, fr, de, jp...) (default "en")
+	  -o string
+			The criterion to use for the search order (relevance, date, views, rating) (default "relevance")
+	  -p int
+			The page to get
+
+## Build & install
+
+To build metube, simply install go and run:
+
+	$ go build
+
+To install, you can run:
+
+	# GOBIN=/usr/local/bin go install
+
+To build the docs, install [scdoc](https://git.sr.ht/~sircmpwn/scdoc) and run:
+
+	$ cd doc
+	$ make
+	# make install
+
+## Patches
+
+Most if not all patches will probably concern [ytparser](https://git.sr.ht/~ark/ytparser).