docs: update license and readme.md
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Manuel Martínez-Almeida
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
30
README.md
30
README.md
@@ -1,18 +1,18 @@
|
|||||||
# atom
|
# atom
|
||||||
atom go http service template
|
atom is a simple http/grpc service template
|
||||||
|
|
||||||
|
## Tool
|
||||||
|
- [atomctl](https://github.com/rogeecn/atomctl)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- using [Gin](https://github.com/gin-gonic/gin) to support http service
|
||||||
|
- using [dig](https://github.com/uber-go/dig) to support dependency injection
|
||||||
|
- using [gomigrate](github.com/go-gormigrate/gormigrate/v2) to support migration
|
||||||
|
- using [Gorm](gorm.io/gorm) to support orm
|
||||||
|
- using [gen](gorm.io/) to auto generate database models
|
||||||
|
|
||||||
|
## License
|
||||||
|
MIT
|
||||||
|
## Contact
|
||||||
|
- Rogee(rogeecn@qq.com)
|
||||||
|
|
||||||
## docker compose
|
|
||||||
```
|
|
||||||
version: '3'
|
|
||||||
services:
|
|
||||||
db:
|
|
||||||
image: mariadb:latest
|
|
||||||
restart: always
|
|
||||||
ports:
|
|
||||||
- 3306:3306
|
|
||||||
environment:
|
|
||||||
MARIADB_DATABASE: demos
|
|
||||||
MARIADB_ROOT_HOST: "%"
|
|
||||||
MARIADB_ROOT_PASSWORD: root
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user