diff --git a/README.md b/README.md index 90e37ba38d..1bcee95d66 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # unleash -__Warning: We are in the process of splitting up unleash into multiple packages in this repository, if you want to test the previous package see [previous tag](https://github.com/unleash/unleash/tree/v1.0.0-alpha.2) __ +__Warning: We will soon release the first official version of Unleash (1.0.0). If you want to test the previous package see [previous tag](https://github.com/unleash/unleash/tree/v1.0.0-alpha.2) __ [![Build Status](https://travis-ci.org/Unleash/unleash.svg?branch=master)](https://travis-ci.org/Unleash/unleash) [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash?branch=master) @@ -14,79 +14,14 @@ This repo contains the unleash-server, which contains the admin UI and a place t Known client implementations: - [unleash-client-java](https://github.com/unleash/unleash-client-java) - [unleash-client-node](https://github.com/unleash/unleash-client-node) +- (you implementaiton here!) ## Project details - [Project Roadmap](https://github.com/unleash/unleash/wiki/Roadmap) +## Developer Guide +If you want to contribute to this project you are encuraged to send issue request, or provie pull-requests. +Please read the [unleas developer guide](./docs/developer-guide.md) to learn more on how you can contribute. + ## Run with docker -We have set up docker-compose to start postgres and the unleash server together. This makes it really fast to start up -unleash locally without setting up a database or node. - -You find the docker files inside the `packages/unleash-docker` folder - -```bash -$ docker-compose build -$ docker-compose up -``` - -## Development - -### Create a local unleash databases in postgres - -```bash -$ psql postgres <