Skip to content

Commit

Permalink
chore: docs updated for v1.6.x
Browse files Browse the repository at this point in the history
  • Loading branch information
pilinux committed Sep 28, 2022
1 parent 161eab7 commit 23ec835
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,16 @@ _Note:_ gorest uses [GORM][21] as its ORM

## Start building

_Tutorials:_ [Wiki][10]
Please study the `.env.sample` file. It is one of the most crucial files required
to properly set up a new project. To load all environment variables, either rename
the `.env.sample` file to `.env`, or set all the environment variables in your
development or production instance manually.

For version `1.6.x`, I will publish new tutorials in my free time.
_Tutorials:_

For version `1.6.x`, please check the project in [example](example)

For version `1.4.x` and `1.5.x`, [Wiki][10]

- convention over configuration

Expand All @@ -88,10 +95,9 @@ import (
- set up an environment to compile the Go codes (a [quick tutorial][41]
for any Debian based OS)
- install `git`
- check the [Wiki][10] for tutorials
- check the [Wiki][10] and [example](example) for tutorials and implementations

_Note:_ Omit the line `setPkFk()` in `autoMigrate.go` file if the driver is not **MySQL**
([check issue: 7][42])
_Note:_ For **MySQL** driver, please [check issue: 7][42]

**Note For SQLite3:**

Expand Down
5 changes: 2 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

| Version | Supported |
| ------- | ------------------ |
| >=1.5.1 | :white_check_mark: |
| 1.4.x | :white_check_mark: |
| < 1.4 | :x: |
| >=1.6.x | :white_check_mark: |
| < 1.6 | :x: |

## Reporting a Vulnerability

Expand Down

0 comments on commit 23ec835

Please sign in to comment.