Skip to content

Commit

Permalink
enhance README.md and remove finished TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
AndersonQ committed Oct 4, 2019
1 parent 1d873e0 commit d42d69c
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,46 @@ A skeleton for go microservices


## Motivation
Besides avoiding to copy from the last microservice I've writte, a friend asked how I'd do it.
Besides avoiding to copy it from the last microservice I've written, a friend asked how I'd do it.
That's is how I'm doing it right now


## Dependencies

```bash
make deps
```

## Run

### Local
```bash
go run main.go
```

## TODO
#### Docker
```bash
docker run --rm -e ENV=dev -p8000:8000 go-skeleton
```

## Build

### Local
```bash
make build
```

### Docker

- Finish the readme
- add Makefile
- add Dockerfile
```bash
docker build -t go-skeleton .
```

## Test

```bash
make test
```

## Licence
See [LICENCE](LICENSE)
Expand Down

0 comments on commit d42d69c

Please sign in to comment.