Skip to content

Commit cb762c2

Browse files
author
Mike Davis
authored
Add CHANGLOG and update README. (#77)
1 parent 7132fb7 commit cb762c2

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7+
## [0.8.0] - November 18th, 2019
8+
- Adds ability to limit the number of active api connections
9+
- Allows SDK keys to be bootstrapped during startup
10+
- Adds http server timeouts
11+
- Adds graceful shutdown hooks
12+
- Adds support for forced variation API
13+
- Adds support for experimentation APIs
14+
715
## [0.7.0] - November 7th, 2019
816
- Adds request timing metrics
917
- Allows config file location to be set

README.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
[![Build Status](https://travis-ci.com/optimizely/sidedoor.svg?token=y3xM1z7bQsqHX2NTEhps&branch=master)](https://travis-ci.com/optimizely/sidedoor)
22
[![codecov](https://codecov.io/gh/optimizely/sidedoor/branch/master/graph/badge.svg?token=UabuO3fxyA)](https://codecov.io/gh/optimizely/sidedoor)
33
# Optimizely Sidedoor
4-
Exploratory project for developing a service version of the Optimizely SDK.
4+
Sidedoor is the Optimizely Full Stack Service which exposes the functionality of a Full Stack SDK as
5+
a highly available and distributed application.
56

67
## Package Structure
78
Following best practice for go project layout as defined [here](https://github.com/golang-standards/project-layout)
89

910
* **api** - OpenAPI/Swagger specs, JSON schema files, protocol definition files.
10-
* **cmd** - Main applications for this project.
1111
* **bin** - Compiled application binaries.
12-
* **pkg** - Library code that can be used by other applications
12+
* **cmd** - Main applications for this project.
13+
* **docs** - User documentation files.
14+
* **pkg** - Library code that can be used by other applications.
1315
* **scripts** - Scripts to perform various build, install, analysis, etc operations.
1416

1517
## Make targets
@@ -22,16 +24,6 @@ The following `make` targets can be used to build and run the application:
2224
* **run** - builds and executes the sidedoor binary
2325
* **test** - recursively tests all .go files
2426

25-
## Running locally
26-
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.
27-
28-
Ex:
29-
```
30-
SDK_KEY=<YOUR-KEY-KEY> make run
31-
```
32-
33-
This file will get loaded via the `Makefile` configuration script.
34-
3527
## Prerequisites
3628
Install go on OSX:
3729
```

0 commit comments

Comments
 (0)