From 0b84be3eb529a2dd02dc9cc5c1be7576072c3ed7 Mon Sep 17 00:00:00 2001 From: konrad Date: Sat, 1 Dec 2018 00:01:55 +0100 Subject: [PATCH] improved docs --- Readme.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index e05cbdd..b49a204 100644 --- a/Readme.md +++ b/Readme.md @@ -16,8 +16,9 @@ implementations thus leading to much flexibility. * Manages rights * Pluggable authentication mechanisms -### Table of contents +## Table of contents +* [Installation](#installation) * [CRUDable](#crudable) * [Rights](#rights) * [Handler Config](#handler-config) @@ -30,6 +31,10 @@ implementations thus leading to much flexibility. * [Standard web handler](#standard-web-handler) * [Errors](#errors) +## Installation + +Using the web handler in your application is pretty straight forward, simply run `go get -u code.vikunja.io/web` and start using it. + In order to use the common web handler, the struct must implement the `web.CRUDable` and `web.Rights` interface. ## CRUDable