From 20b75a492473fc1f929fb066c4dc54ffb4f26390 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Wed, 27 Jun 2018 22:31:11 +0200 Subject: [PATCH] Add docs for usage of terms and privacy policy Signed-off-by: Sheogorath --- docs/guides/providing-terms.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/guides/providing-terms.md diff --git a/docs/guides/providing-terms.md b/docs/guides/providing-terms.md new file mode 100644 index 0000000..1e580df --- /dev/null +++ b/docs/guides/providing-terms.md @@ -0,0 +1,17 @@ +Setup your terms of use +=== + +To setup your terms of use, you need to provide a document called `terms-of-use.md` which contains them. Of course written in Markdown. + +It has to be provided under `./public/docs/` and will be automatically turned into a CodiMD document. It will also automatically updated as soon as you change the document on disk. + +As soon as the file exists a link will show up in the bottom part along with the release notes and link to them. + +Setup your privacy policy +=== + +To add a privacy policy you can use the same technique as for the terms of use. The main difference is that the document is called `privacy.md`. + +See our example file `./public/docs/privacy.md.example` container some useful hints for writing your own privacy policy. + +As with the terms of use, a link to the privacy notices will show up in the area where the release notes are provided on the index page.