go/aicra
go
/
aicra
0
1
Fork 0
Code Issues Pull Requests Releases 3 Wiki Activity

update readme install command

This commit is contained in:
Adrien Marquès 2018-10-02 09:58:51 +02:00
parent 85a0521723
commit 8c0d4df4b3
1 changed files with 5 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -34,7 +34,6 @@ This framework is based over some of the following concepts.
- [I. Installation](#i-installation) - [I. Installation](#i-installation)
* [1. Download and install the package](#1-download-and-install-the-package) * [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) - [II. Setup a project](#ii-setup-a-project)
* [1. Configuration](#1-configuration) * [1. Configuration](#1-configuration)
* [2. Controllers](#2-controllers) * [2. Controllers](#2-controllers)
@ -57,22 +56,10 @@ You need a recent machine with `go` [installed](https://golang.org/doc/install).
##### 1. Download and install the package ##### 1. Download and install the package
```bash ```bash
go get -u git.xdrm.io/go/aicra go get -u git.xdrm.io/go/aicra/cmd/aicra
``` ```
It should now be available locally and available for your imports. The library should now be available locally and available for your imports. Moreover, the **project compilet** have been installed as the `aicra` command.
##### 2. Compile the command-line compiler
You should then compile the project compiler to help you manage your projects.
```bash
go install git.xdrm.io/go/aicra/cmd/aicra
```
> The executable `aicra` will be placed into your `$GOPATH/bin` folder, if added to your environment PATH it should be available as a standalone command in your terminal. If not, you can simply run `$GOPATH/bin/aicra` to use the command or create a symlink into `/usr/local/bin` for instance. > The executable `aicra` will be placed into your `$GOPATH/bin` folder, if added to your environment PATH it should be available as a standalone command in your terminal. If not, you can simply run `$GOPATH/bin/aicra` to use the command or create a symlink into `/usr/local/bin` for instance.
@ -183,7 +170,7 @@ In order for your project to manage authentication, the best solution is to crea
###### Plugin driver ###### Plugin driver
Each middleware must be **directly** inside the `middleware` folder (according to the _aicra.json_ configuration). Each middleware must be **directly** inside the `middleware` folder (according to the _aicra.json_ configuration).
> Example - the `1-authentication` middleware will be inside `middleware/1-authentication/main.go`. > Example - the `1-authentication` middleware will be inside `middleware/1-authentication/main.go`.
@ -215,7 +202,7 @@ Each type must be **directly** inside the `type` folder. The package name is arb
###### Plugin driver ###### Plugin driver
Each type checker must be **directly** inside the `type` folder (according to the _aicra.json_ configuration). Each type checker must be **directly** inside the `type` folder (according to the _aicra.json_ configuration).
> Example - the `number` type checker will be inside `type/number/main.go`. > Example - the `number` type checker will be inside `type/number/main.go`.
@ -315,4 +302,4 @@ func main() {
- [x] type checkers - [x] type checkers
- [x] project configuration file to select **driver**, source folders and whether to load default type checkers. - [x] project configuration file to select **driver**, source folders and whether to load default type checkers.
- [x] used to compile the project by the `aicra` command - [x] used to compile the project by the `aicra` command
- [x] used to create an API from `aicra.New()` - [x] used to create an API from `aicra.New()`