diff --git a/.github/images/console.png b/.github/images/console.png
new file mode 100644
index 0000000000..88b80911da
Binary files /dev/null and b/.github/images/console.png differ
diff --git a/.github/images/flags.png b/.github/images/flags.png
new file mode 100644
index 0000000000..bfb5b94377
Binary files /dev/null and b/.github/images/flags.png differ
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 2774b2e16b..a2b5c8f73c 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -99,9 +99,15 @@ jobs:
TAG: ${{ github.ref_name }}
run: |
if [[ $TAG == $(cat version.txt) ]]; then
+ docker pull flipt/flipt:$TAG
docker tag flipt/flipt:$TAG flipt/flipt:latest
+
+ docker pull markphelps/flipt:$TAG
docker tag markphelps/flipt:$TAG markphelps/flipt:latest
+
+ docker pull ghcr.io/flipt-io/flipt:$TAG
docker tag ghcr.io/flipt-io/flipt:$TAG ghcr.io/flipt-io/flipt:latest
+
docker push flipt/flipt:latest
docker push markphelps/flipt:latest
docker push ghcr.io/flipt-io/flipt:latest
diff --git a/README.md b/README.md
index 2bcdd7fb13..f1dcab8e1a 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,9 @@
-
+
+ 
+
+
+
Flipt is an open source, self-hosted feature flag application that allows you to run experiments across services in **your** environment.
Flipt can be deployed within your existing infrastructure so that you don't have to worry about your information being sent to a third party or the latency required to communicate across the internet.
@@ -56,18 +60,24 @@ Flipt supports use cases such as:
- Rolling out features to a percentage of your customers
- Using advanced segmentation to target and serve users based on custom properties that you define
+
+
## Features
+
+
- Fast. Written in Go. Optimized for performance
- Stand alone, easy to run and configure
- Ability to create advanced distribution rules to target segments of users
- Native [GRPC](https://grpc.io/) client SDKs to integrate with your existing applications easily
- Powerful REST API
- Modern, mobile friendly 📱 UI and debug console
-- Support for multiple databases (Postgres, MySQL, SQLite)
+- Support for multiple databases (Postgres, MySQL, SQLite, CockroachDB)
- Data import and export to allow storing your data as code
- Cloud ready :cloud:. Runs anywhere: bare metal, PaaS, K8s, with Docker or without.
+
+
## Values
- :lock: **Security** - HTTPS support. No data leaves your servers and you don't have to open your systems to the outside world to communicate with Flipt. It all runs within your existing infrastructure.
@@ -75,15 +85,17 @@ Flipt supports use cases such as:
- :white_check_mark: **Simplicity** - Flipt is a single binary with no external dependencies by default.
- :thumbsup: **Compatibility** - REST, GRPC, MySQL, Postgres, CockroachDB, SQLite, Redis.. Flipt supports it all.
+
+
## Works With
- 
- 
- 
- 
- 
- 
+
+
+
+
+
+
## Try It
@@ -114,27 +126,7 @@ Like to live on the edge? Can't wait for the next release? Our nightly builds in
docker run --rm -p 8080:8080 -p 9000:9000 -t flipt/flipt:nightly
```
-## Logos
-
-Some of the companies depending on Flipt in production.
-
-
-
- 
-
-
- 
-
-
- 
-
-
-
-Using Flipt at your company? Open a PR and add your logo here!
-
-## Office Hours
-
-Join us on [Discord](https://www.flipt.io/discord) :keyboard: and/or [Whereby](https://whereby.com/flipt) :video_camera: for office hours every Wednesday at 10am ET to chat about anything Flipt related or just to say hi.
+
## Integration
@@ -178,12 +170,16 @@ Note: These libraries are not maintained by the Flipt team and may not be up to
If a client in your language is not available for download, you can easily generate one yourself using the existing [protobuf definition](https://github.com/flipt-io/flipt/blob/main/rpc/flipt/flipt.proto). The [GRPC documentation](https://grpc.io/docs/) has extensive examples on how to generate GRPC clients in each supported language.
+
+
## Examples
Check out the [examples](/examples) to see how Flipt works.
Here's a [basic one](https://github.com/flipt-io/flipt/tree/main/examples/basic) to get started!
+
+
## Licensing
There are currently two types of licenses in place for Flipt:
@@ -205,19 +201,39 @@ The server code is licensed under the [GPL 3.0 License](https://spdx.org/license
See [LICENSE](LICENSE).
+
+
+## Logos
+
+Some of the companies depending on Flipt in production.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Using Flipt at your company? Open a PR and add your logo here!
+
+
+
## Community
For help and discussion around Flipt, feature flag best practices, and more, join us on [Discord](https://www.flipt.io/discord).
+
+
## Feedback
If you are a user of Flipt we'd really :heart: it if you could leave a [testimonal](https://testimonial.to/flipt) on how Flipt is working for you.
-## Author
-
-| [](https://twitter.com/intent/user?screen_name=mark_a_phelps "Follow @mark_a_phelps on Twitter") |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Mark Phelps](https://markphelps.me/) |
+
## Contributing
@@ -225,6 +241,8 @@ We would love your help! Before submitting a PR, please read over the [Contribut
No contribution is too small, whether it be bug reports/fixes, feature requests, documentation updates, or anything else that can help drive the project forward.
+
+
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
diff --git a/demo.gif b/demo.gif
deleted file mode 100644
index 8a0bcbc77f..0000000000
Binary files a/demo.gif and /dev/null differ
diff --git a/ui/README.md b/ui/README.md
new file mode 100644
index 0000000000..db851a62a5
--- /dev/null
+++ b/ui/README.md
@@ -0,0 +1,7 @@
+# Flipt UI
+
+Looking for the UI? It has been migrated to it's own repository: [flipt-ui](https://github.com/flipt-io/flipt-ui).
+
+## Development
+
+We're actively working on making the development process easier, so stay tuned! If you have any suggestions, please [open an issue](https://github.com/flipt-io/flipt/issues/new) or chat with us in our [Discord server](https://www.flipt.io/discord).