From 7b7ff863b554231226b58ba5e991ed0c56031ae2 Mon Sep 17 00:00:00 2001 From: Christian Schabesberger Date: Wed, 21 Feb 2018 00:00:29 +0100 Subject: [PATCH] update readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 27f2616..ae5ac78 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ NewPipe Tutorial ================ -This is the tutorial for the [NewPipeExtractor](https://github.com/TeamNewPipeExtractor). It's thought for thous who want to write their own service, or use NewPipeExtractor in theyr own projects. +This is the [tutorial](https://teamnewpipe.github.io/tutorial/) for the [NewPipeExtractor](https://github.com/TeamNewPipeExtractor). +It's thought for thous who want to write their own service, or use NewPipeExtractor in their own projects. -This tutorial and the documentation are in an early state. So [feedback](https://github.com) is always welcome :D +This tutorial and the documentation are in an early state. So [feedback](https://github.com/TeamNewPipe/tutorial/issues) is always welcome :D + +The tutorial is crated using [`mkdocs`](http://www.mkdocs.org/). You can test and host it your self by running `mkdocs serve` in the root +directory of this project. If you want to deploy your changes and you are one of the maintainers you can run `mkdocs gh-deploy && git push`. ## License