From cb762c2f00463527802473a249046e5d2ddfa7d6 Mon Sep 17 00:00:00 2001 From: Mike Davis Date: Mon, 18 Nov 2019 13:13:07 -0800 Subject: [PATCH] Add CHANGLOG and update README. (#77) --- CHANGELOG.md | 8 ++++++++ README.md | 18 +++++------------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f34486b..d0ae72c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## [0.8.0] - November 18th, 2019 +- Adds ability to limit the number of active api connections +- Allows SDK keys to be bootstrapped during startup +- Adds http server timeouts +- Adds graceful shutdown hooks +- Adds support for forced variation API +- Adds support for experimentation APIs + ## [0.7.0] - November 7th, 2019 - Adds request timing metrics - Allows config file location to be set diff --git a/README.md b/README.md index 2fb8cd2a..fafa4247 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ [![Build Status](https://travis-ci.com/optimizely/sidedoor.svg?token=y3xM1z7bQsqHX2NTEhps&branch=master)](https://travis-ci.com/optimizely/sidedoor) [![codecov](https://codecov.io/gh/optimizely/sidedoor/branch/master/graph/badge.svg?token=UabuO3fxyA)](https://codecov.io/gh/optimizely/sidedoor) # Optimizely Sidedoor -Exploratory project for developing a service version of the Optimizely SDK. +Sidedoor is the Optimizely Full Stack Service which exposes the functionality of a Full Stack SDK as +a highly available and distributed application. ## Package Structure Following best practice for go project layout as defined [here](https://github.com/golang-standards/project-layout) * **api** - OpenAPI/Swagger specs, JSON schema files, protocol definition files. -* **cmd** - Main applications for this project. * **bin** - Compiled application binaries. -* **pkg** - Library code that can be used by other applications +* **cmd** - Main applications for this project. +* **docs** - User documentation files. +* **pkg** - Library code that can be used by other applications. * **scripts** - Scripts to perform various build, install, analysis, etc operations. ## Make targets @@ -22,16 +24,6 @@ The following `make` targets can be used to build and run the application: * **run** - builds and executes the sidedoor binary * **test** - recursively tests all .go files -## Running locally -Currently the Optimizely SDK Key is sourced from an `SDK_KEY` environment variable. For local development you can export your `SDK_KEY` or prefix the `make run` command. - -Ex: -``` -SDK_KEY= make run -``` - -This file will get loaded via the `Makefile` configuration script. - ## Prerequisites Install go on OSX: ```