diff --git a/README.md b/README.md index b4ffb0dec70..54a08f1280e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ +

## About Unleash Unleash is an open source feature management solution. It improves the workflow of your development team and leads to quicker software delivery. Unleash increases efficiency and gives teams *full control* of how and when they enable new functionality for end users. Unleash lets teams ship code to production in *smaller* releases *whenever* they want. @@ -20,6 +21,7 @@ Feature toggles make it easy to test how your code works with real production da Unleash is the largest open source solution for feature flagging on GitHub. There's 12 official client and server SDKs and 10+ community SDKs available; you can even make your own if you want to. You can use Unleash with any language and any framework. +

## Get started in 2 steps ### 1. Start Unleash @@ -73,12 +75,14 @@ If you don't want to run Unleash locally, we also provide easy deployment setups The above sections show you how to get up and running quickly and easily. When you're ready to start configuring and customizing Unleash for your own environment, check out the documentation for [getting started with self-managed deployments](https://docs.getunleash.io/deploy/getting_started), [Unleash configuration options](https://docs.getunleash.io/deploy/configuring_unleash), or [running Unleash locally via docker](https://docs.getunleash.io/user_guide/quickstart#i-want-to-run-unleash-locally). +

## Online demo Try out [the Unleash online demo](https://www.getunleash.io/interactive-demo). ![The Unleash UI. It shows a project and its users, feature toggles and tabs for health, access, and environments.](./.github/github_online_demo.svg) +

## Community and help — sharing is caring We know that learning a new tool can be hard and time-consuming. We have a growing community that loves to help out. Please don't hesitate to reach out for help. @@ -91,6 +95,7 @@ We know that learning a new tool can be hard and time-consuming. We have a growi 📚 [Visit the documentation](https://docs.getunleash.io/) for more in-depth descriptions, how-to guides, and more. +

## Contribute to Unleash Building Unleash is a collaborative effort, and we owe a lot of gratitude to many smart and talented individuals. @@ -99,6 +104,7 @@ We'd love to have your help too: Please feel free to open issues or provide pull Check out [the CONTRIBUTING.md file](./CONTRIBUTING.md) for contribution guidelines and the [Unleash developer guide](./website/docs/contributing/developer-guide.md) for tips on environment setup, running the tests, and running Unleash from source. +

## Features our users love ### Flexibility and adaptability @@ -137,12 +143,14 @@ If you're looking for one of the following features, please take a look at our [ - tighter security - more hosting options (we can even host it for you!) +

## Architecture Read more in the [*system overview* section of the Unleash documentation](https://docs.getunleash.io/user_guide/unleash_overview#system-overview). +

## Unleash SDKs To connect your application to Unleash you'll need to use a client SDK for your programming language. @@ -171,6 +179,7 @@ The front-end SDKs connects via the [Unleash Proxy](https://docs.getunleash.io/s If none of the official SDKs fit your need, there's also a number of [community-developed SDKs](https://docs.getunleash.io/sdks#community-sdks) where you might find an implementation for your preferred language (such as [Elixir](https://gitlab.com/afontaine/unleash_ex), [Dart](https://pub.dev/packages/unleash), [Clojure](https://github.com/AppsFlyer/unleash-client-clojure), and more). +

## Users of Unleash **Unleash is trusted by thousands of companies all over the world**. @@ -179,6 +188,7 @@ If none of the official SDKs fit your need, there's also a number of [community- ![The Unleash logo encircled by logos for Finn.no, nav (the Norwegian Labour and Welfare Administration), Budgets, Otovo, and Amedia. The encircling logos are all connected to the Unleash logo.](./.github/github_unleash_users.svg) +

## Want to know more about Unleash? ### Videos and podcasts