From d47a745437cddc4a5dcfa69c210c0c072512cf9c Mon Sep 17 00:00:00 2001 From: Andrew Scott Date: Sun, 7 Aug 2022 00:03:04 -0400 Subject: [PATCH] Minor updates --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a3349d2..39b6e40 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,29 @@ At minimum, an API key that can access the the [Geocoding](https://openweathermap.org/api/geocoding-api) APIs is required. +### Starting the Server + Before starting the server a file named `.env` must be be added to the -root directory of the project, or the directory that contains the binary file, -with the following fields: +root directory of the project, or the directory from which you'll execute +the binary file, with the following fields: ``` API_KEY=xxxxxxxxxxxxxxxx PORT=xxxxx ``` +If you don't want to compile the code or can't use one of the binary releases +you can run the server with the command `go run server/*.go` from the +root of the project. + ## Sending Requests ### Basic Workflow -1. Generate the necessary code for your preferred language from the files in -the proto directory with the protoc compiler - - Note that the `protoc-gen-go` and `protoc-gen-go-grpc` plugins must be installed -2. Import the code into your project +1. Generate some server-side code and the code for your preferred language from the files in +the proto directory with the protocol compiler `protoc` + - Note that the `protoc-gen-go` and `protoc-gen-go-grpc` plugins must be installed to generate the server-side code +2. Import your newly generated code into your project (Leave the servers code in the proto directory) 3. Use the imported code to allow your client to connect with the server 4. Use the imported code within your own functions to make requests