Skip to content
This repository has been archived by the owner on Oct 28, 2021. It is now read-only.

Commit

Permalink
Merge pull request #4 from Minish144/readme
Browse files Browse the repository at this point in the history
Readme update
  • Loading branch information
Minish144 committed Sep 30, 2021
2 parents 539908d + 19cbad4 commit 503e17b
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# go-sms-api
# Golang SMS API
## Usage
### Preparations
Edit `config.yaml`

## Running
`sudo go run main.go`
### Installation
```bash
$ go build
```

### Running
```bash
$ sudo ./go-sms-api # sudo is required
```

## Development
### Dependencies
```bash
$ export GO111MODULE=off

$ go get github.com/grpc-ecosystem/grpc-gateway

$ go get github.com/envoyproxy/protoc-gen-validate

$ cd ~/go/src/github.com/grpc-ecosystem/grpc-gateway
$ mkdir third_party && cd third_party
$ git clone https://github.com/googleapis/googleapis.git
```

0 comments on commit 503e17b

Please sign in to comment.