vikunja
/
web
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improved docs

This commit is contained in:
konrad 2018-12-01 00:01:55 +01:00
parent 2ac2530c38
commit 0b84be3eb5
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Readme.md
View File

@ -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