Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

[![codecov](https://codecov.io/gh/flagship-io/decision-api/branch/main/graph/badge.svg?token=Jvuh2U89uA)](https://codecov.io/gh/flagship-io/decision-api)
[![Go Report Card](https://goreportcard.com/badge/github.com/flagship-io/decision-api)](https://goreportcard.com/report/github.com/flagship-io/decision-api)
[![CI](https://github.com/flagship-io/decision-api/actions/workflows/ci.yml/badge.svg)](https://github.com/flagship-io/decision-api/actions/workflows/ci.yml)
[![CI](https://github.com/flagship-io/decision-api/actions/workflows/ci.yml/badge.svg)](https://github.com/flagship-io/decision-api/actions/workflows/ci.yml)

**Visit [https://docs.developers.flagship.io/](https://docs.developers.flagship.io/) to get started with Flagship.**
**Visit [https://docs.abtasty.com/server-side](https://docs.abtasty.com/server-side) to get started with Flagship.**

## Disclaimer

Expand All @@ -26,16 +26,20 @@
## Docs

### Installation

The Flagship Decision API can be installed and deployed in your infrastructure either by downloading and running the binary, or pulling and running the docker image in your orchestration system.

#### Using a binary

You can download the latest binary here: https://github.com/flagship-io/decision-api/releases

#### Using a Docker image

You can pull the latest docker image from docker hub:
`docker pull flagshipio/decision-api`

### Running

Using a binary
Download the latest release on github and then simply run:

Expand All @@ -49,9 +53,10 @@ Run the following command to start the server with Docker
`docker run -p 8080:8080 -e ENV_ID={your_env_id} -e API_KEY={your_api_key} flagshipio/decision-api`

### Configuration

Full configuration and API options available here:

[https://docs.developers.flagship.io/docs/run-on-premise](https://docs.developers.flagship.io/docs/run-on-premise)
[https://docs.abtasty.com/server-side/decision-api/run-on-premise](https://docs.abtasty.com/server-side/decision-api/run-on-premise)

## Licence

Expand Down
Loading