From e13732c3812bc6cc0ed1387b4f7e54eacbff341b Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Wed, 11 Jul 2018 19:13:15 +0200 Subject: [PATCH] add readme TOC (table of contents) --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c3f3b14..5cd632b 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,22 @@ This framework is based over some of the following concepts. > A working example is available [here](https://git.xdrm.io/example/aicra) - #### Table of contents + -[TOC] - +- [I. Installation](#i-installation) + * [1. Download and install the package](#1-download-and-install-the-package) + * [2. Compile the command-line builder](#2-compile-the-command-line-builder) +- [II. Setup a project](#ii-setup-a-project) + * [1. Configuration](#1-configuration) + * [2. Controllers](#2-controllers) + * [3. Middlewares](#3-middlewares) + * [4. Custom types](#4-custom-types) +- [III. Build your project](#iii-build-your-project) +- [IV. Main](#iv-main) +- [V. Change Log](#v-change-log) + #### I. Installation @@ -164,13 +174,13 @@ import ( ) func main() { - + // 1. create server server, err := aicra.New("manifest.json") if err != nil { panic(err) } - + // 2. listen to incoming http requests err = http.ListenAndServe("127.0.0.1:4242", server) if err != nil { @@ -206,4 +216,4 @@ func main() { - [ ] `` - map containing **only** keys of type `a` and values of type `b` (*a or b can be ommited*) - [x] generic controllers implementation (shared objects) - [x] response interface -- [ ] devmode watcher : watch manifest, watch plugins to compile + hot reload them \ No newline at end of file +- [ ] devmode watcher : watch manifest, watch plugins to compile + hot reload them