Skip to content

Commit

Permalink
Add CHANGLOG and update README. (#77)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Davis authored Nov 18, 2019
1 parent 7132fb7 commit cb762c2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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=<YOUR-KEY-KEY> make run
```

This file will get loaded via the `Makefile` configuration script.

## Prerequisites
Install go on OSX:
```
Expand Down

0 comments on commit cb762c2

Please sign in to comment.