This repository has been archived by the owner on Oct 28, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from Minish144/readme
Readme update
- Loading branch information
Showing
1 changed file
with
27 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |