add readme TOC (table of contents)
This commit is contained in:
parent
4264a10891
commit
e13732c381
22
README.md
22
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)
|
> A working example is available [here](https://git.xdrm.io/example/aicra)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Table of contents
|
#### Table of contents
|
||||||
|
<!-- toc -->
|
||||||
|
|
||||||
[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)
|
||||||
|
|
||||||
|
<!-- tocstop -->
|
||||||
|
|
||||||
#### I. Installation
|
#### I. Installation
|
||||||
|
|
||||||
|
@ -164,13 +174,13 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
|
||||||
// 1. create server
|
// 1. create server
|
||||||
server, err := aicra.New("manifest.json")
|
server, err := aicra.New("manifest.json")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// 2. listen to incoming http requests
|
// 2. listen to incoming http requests
|
||||||
err = http.ListenAndServe("127.0.0.1:4242", server)
|
err = http.ListenAndServe("127.0.0.1:4242", server)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -206,4 +216,4 @@ func main() {
|
||||||
- [ ] `<a:b>` - map containing **only** keys of type `a` and values of type `b` (*a or b can be ommited*)
|
- [ ] `<a:b>` - 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] generic controllers implementation (shared objects)
|
||||||
- [x] response interface
|
- [x] response interface
|
||||||
- [ ] devmode watcher : watch manifest, watch plugins to compile + hot reload them
|
- [ ] devmode watcher : watch manifest, watch plugins to compile + hot reload them
|
||||||
|
|
Loading…
Reference in New Issue