From fe276e5c2ed21f4bb0c92c05a23b5b1d7afdf978 Mon Sep 17 00:00:00 2001 From: Garrett Dimon Date: Thu, 3 Aug 2023 09:51:46 -0600 Subject: [PATCH] Initial Readme for Org GitHub Profile Needs some editing once we dial in sponsorships and release the free plan. --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5647f0c..2369040 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,61 @@ -# .github -Flipper Cloud +![Flipper Cloud](https://github.com/flippercloud/.github/assets/6214/22dce542-8157-4062-947b-8be3c9bfb5be) + +# Flipper Cloud +[Flipper is an open-core feature flag library]([url](https://github.com/flippercloud/flipper)) for Ruby/Rails applications. + +## Benefits of Flipper & Feature Flags +How can feature flags improve your workflows and release process? Just imagine having the confidence to release new code on a Friday afternoon? + +- ๐Ÿ†• **Provide Early Access** Get real feedback sooner by shipping new features to production behind a feature flag, and then enabled individually for developers and groups of users. +- ๐Ÿ—๏ธ **Roll Out Incrementally** Avoid performance surprises by slowly rolling out new features to a percentage of users, organizations, specific countries, or whatever segments you define. +- ๐Ÿš€ **Reduce Risk of Launches** When your feature has already been in production for weeks behind a feature flag, there's no need to wait for last-minute deploys. Toggle it on with a single click. +- โ˜‘๏ธ **Let Users Opt-in** Minimize disruption by letting your users decide when they want to get familiar with a drastic interface redesign and let your most eager users try it early. +- ๐Ÿ” **Control Permissions** Whether limiting access to premium features or giving teammates and contributors access to administrative features, feature flags make permissions simple. +- ๐Ÿ˜ˆ **Block Bad Actors** Flipper's feature checks are always blazing fast, so you can quickly and easily block bad actors that are abusing your app and rest assured your app is unaffected. +- ๐Ÿ› ๏ธ **Perform Maintenance** Planned or not, feature flags let you limit downtime by disabling only affected features while leaving the rest of the application fully accessible. +- ๐Ÿงช **Run Experiments** Preview how a change affects real users in production by enabling an experimental feature for a percentage of users and then measure the results. +- ๐ŸŒ… **Sunset Old Features** Sunset features the same way you roll them out. Once a feature is disabled, you can untangle and remove it from the code base without risk. + +## Why Flipper Cloud? +- โš™๏ธ **Simple install and setup** [Getting started](https://www.flippercloud.io/docs/get-started) with Flipper is as easy as including _a few lines of code_ into your app. If your app is already using open source Flipper, using Flipper Cloud is as easy as updating your adapter and deploying. +- โคต๏ธ **Cascading environments** We understand the difficulty in managing features through [multile environments](https://www.flippercloud.io/docs/cloud#environments). With Flipper Cloud, you can set a feature in a non-production environment to simply _mirror the production setting_. +- ๐Ÿ““ **Audit history** Flipper Cloud keeps [a history](https://www.flippercloud.io/docs/cloud#audit-history) of all feature changes, and who made them. Easily _revert to a point in time_, or check to make sure a release strategy was followed, and when it was enabled. +- ๐ŸŽ›๏ธ **Advanced flexibility** Different types of [features](https://www.flippercloud.io/docs/features) require _different release strategies_. Enable features for everyone, specific actors (eg. users), groups of users, a percentage of actors, or a percentage of time. +- ๐Ÿ’ซ **Independent availability** With multiple levels of adapters and [reads that are local to your application](https://www.flippercloud.io/docs/cloud#webhooks), you'll have blazing fast feature checks that are always available and in sync, even if Flipper Cloud isn't for some reason. +- ๐Ÿ”ฎ **Future proof** Because Flipper Cloud is simply an extra adapter around the open-source version of Flipper, even if Flipper Cloud goes down or closes, your features, code, and strategies _will always be available_. + +## Support & Sponsorships +Help Flipper improve through a a monthly subscription or sponsorship. + +### Plans +View [Flipper Cloud plan options](https://www.flippercloud.io/#pricing). + +- ๐Ÿฌ **Cloud Base** - Hosted with full access to all features for $20/mo per seat. + - Everything in "Cloud Free" and much more! + - Full Audit History and one-click rollbacks for every feature + - Permissions by organization or project + - Switch to Cloudless or Cloud Free at any time + - Full API Access + - Opt-in to upcoming features +- ๐Ÿ†“ **Cloud Free** - Hosted with core features for free. + - Unlimited seats, features, and projects + - Almost Realtime Feature Flag Updates across multiple servers + - Unique logins and personal environments for each team member + - Shared organization-wide permissions + - Centralized backup of feature flage states + - Manage multiple organizations and projects from one place + - Switch to Cloudless or Cloud Base at any time + - Read-only API Access + +- ๐Ÿ†“ **Cloudless** - Open source and Self-hosted and entirely free forever. + - Access one project at a time + - Add `flipper-ui` for a shared interface for controlling features. + - One shared login for all team members + - Unlimited + +### Sponsorships & Consulting +Want help getting the most out of feature flags? We were part of the team that built GitHub's internal feature flags before we created Flipper, and we can help you dial in your own feature flag management as you grow. + +Get support or consulting hours with one-time or recurring sponsorships. + +TODO: Link to sponsorships.