Skip to content

Commit 5039e4f

Browse files
author
Robert Norrie
authored
docs: Update README (#5548)
Updating the readme file.
1 parent e5eff2b commit 5039e4f

4 files changed

Lines changed: 50 additions & 38 deletions

File tree

README.md

Lines changed: 50 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,39 @@
1-
[![Feature Flag, Remote Config and A/B Testing platform, Flagsmith](static-files/hero.png)](https://www.flagsmith.com/)
1+
[![Feature Flag, Remote Config and A/B Testing platform, Flagsmith](static-files/flagsmith-cover.png)](https://www.flagsmith.com/)
22

33
[![Stars](https://img.shields.io/github/stars/flagsmith/flagsmith)](https://github.com/Flagsmith/flagsmith/stargazers)
44
[![Docker Pulls](https://img.shields.io/docker/pulls/flagsmith/flagsmith)](https://hub.docker.com/u/flagsmith)
55
[![Docker Image Size](https://img.shields.io/docker/image-size/flagsmith/flagsmith)](https://hub.docker.com/r/flagsmith/flagsmith)
66
[![Join the Discord chat](https://img.shields.io/discord/517647859495993347)](https://discord.gg/hFhxNtXzgm)
77
[![Coverage](https://codecov.io/gh/Flagsmith/flagsmith/branch/main/graph/badge.svg?token=IyGii7VSdc)](https://codecov.io/gh/Flagsmith/flagsmith)
8+
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
89
<a href="https://depot.dev?utm_source=Flagsmith"><img src="https://depot.dev/badges/built-with-depot.svg" alt="Built with Depot" height="20"></a>
910

10-
[Flagsmith](https://flagsmith.com/) is an open source, fully featured, Feature Flag and Remote Config service. Use our
11-
hosted API, deploy to your own private cloud, or run on-premise.
11+
<p align="center">
12+
<a href="https://www.flagsmith.com/demo">
13+
<img width="75%" height="75%" src="static-files/ReadMe_Demo.gif" alt="Try our interactive demo">
14+
</p>
15+
<p align="center">
16+
<a href="https://www.flagsmith.com/demo">Try our interactive demo </a>
17+
</p>
1218

13-
# Flagsmith
1419

15-
Flagsmith makes it easy to create and manage features flags across web, mobile, and server side applications. Just wrap
20+
# [Flagsmith](https://flagsmith.com/) is an Open-Source Feature Flagging Tool to Ship Faster & Control Releases
21+
22+
Change the way your team releases software. Roll out, segment, and optimise—with granular control. Stay secure with on-premise and private cloud hosting.
23+
24+
* Feature flags: Release features behind the safety of a feature flag
25+
* Make changes remotely: Easily toggle individual features on and off, and make changes without deploying new code
26+
* A/B testing: Use segments to run A/B and multivariate tests on new features
27+
* Segments: Release features to beta testers, collect feedback, and iterate
28+
* Organisation management: Stay organised with orgs, projects, and roles for team members
29+
* SDKs & frameworks: Choose from 15+ popular languages like Typescript, .NET, Java, and more. Integrate with any framework, including React, Next.js, and more
30+
* Integrations: Use your favourite tools with Flagsmith
31+
32+
Flagsmith makes it easy to create and manage feature flags across web, mobile, and server side applications. Just wrap
1633
a section of code with a flag, and then use Flagsmith to toggle that feature on or off for different environments, users
1734
or user segments.
1835

19-
Get up and running in less than a minute:
36+
## Get up and running in less than a minute:
2037

2138
```bash
2239
curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml
@@ -31,51 +48,46 @@ Superuser "admin@example.com" created successfully.
3148
Please go to the following page and choose a password: http://localhost:8000/password-reset/confirm/.../...
3249
```
3350

34-
Note: This setup uses http:// for local development. If you've configured SSL for your local environment, you may use
35-
https:// instead. For any production deployment, always use https://.
36-
3751
![Flagsmith Screenshot](static-files/screenshot.png)
3852

39-
## Features
53+
## Flagsmith Open Source
54+
55+
The Flagsmith repository is comprised of two core components - the [REST API](https://github.com/Flagsmith/flagsmith/tree/main/api) and the [frontend dashboard](https://github.com/Flagsmith/flagsmith/tree/main/frontend).
56+
57+
Further documentation for these can be found at:
58+
59+
* [API](https://docs.flagsmith.com/deployment/hosting/locally-api)
60+
* [Frontend](https://docs.flagsmith.com/deployment/hosting/locally-frontend)
4061

41-
- **Feature flags**. Release features with confidence through phased roll-outs.
42-
- **Remote config**. Easily toggle individual features on and off, and make changes without deploying new code.
43-
- **A/B and Multivariate Testing**. Use segments to run A/B and multivariate tests on new features. With segments, you
44-
can also introduce beta programs to get early user feedback.
45-
- **Organization Management**. Organizations, projects, and roles for team members help keep your deployment organized.
46-
- **Integrations**. Easily enhance Flagsmith with your favourite tools.
62+
## Flagsmith hosted SaaS
63+
You can try our hosted version for free at https://flagsmith.com
4764

48-
## Trying Flagsmith
65+
## Community Resources + Contribution Guidelines
4966

50-
### Flagsmith hosted SaaS
67+
* [Visit our docs](https://docs.flagsmith.com/)
68+
* [Chat with other developers on Discord](https://discord.com/invite/hFhxNtXzgm)
69+
* If you need help getting up and running, please [get in touch](https://www.flagsmith.com/contact-us)
5170

52-
You can try our hosted version for free at https://flagsmith.com/
71+
We love contributions from the community and are always looking to improve! Here are our [contribution guidelines](https://docs.flagsmith.com/platform/contributing).
5372

54-
### Flagsmith Open Source
73+
## Open Source Philosophy
5574

56-
The Flagsmith API is built using Python 3, Django 4, and DjangoRestFramework 3. You can try the application out using:
75+
The majority of our platform is open source under the [BSD-3-Clause license](https://github.com/Flagsmith/flagsmith?tab=BSD-3-Clause-1-ov-file#readme). A small number of repositories are under the MIT license.
5776

58-
- [Docker](https://github.com/Flagsmith/flagsmith/blob/main/docker-compose.yml)
59-
- [Kubernetes](https://github.com/Flagsmith/flagsmith-charts)
60-
- [Redhat OpenShift](https://operatorhub.io/operator/flagsmith)
77+
We built Flagsmith as the open source feature flag tool we needed but couldn't find on GitHub. Our core functionality stays open, always. Read our [open letter to developers](https://www.flagsmith.com/about-us).
6178

62-
We also have options for deploying to AWS, GCP, Azure and On-Premise. If you need help getting up and running, please
63-
[get in touch!](mailto:support@flagsmith.com)
79+
## Open Source vs Paid
6480

65-
## Overview
81+
With our core functionality being open, you can use our open-source feature flag and remote config management platform no matter what. Enterprise-level governance and management features are available with a valid Flagsmith Enterprise license.
6682

67-
This repository is formed of 2 core components, the REST API (found in `/api`) and the web-based administrator dashboard
68-
(found in `/frontend`) that you can use to manage Flagsmith. Technical documentation for each component can be found at
69-
the [API](https://docs.flagsmith.com/deployment/locally-api) and
70-
[Frontend](https://docs.flagsmith.com/deployment/locally-frontend) pages within our
71-
[Documentation](https://docs.flagsmith.com/)
83+
To learn more, [contact us](https://www.flagsmith.com/contact-us) or see our [version comparison](https://docs.flagsmith.com/version-comparison).
7284

73-
These two components run as separate applications. The web-based dashboard is a single page app that communicates via
74-
REST calls to the API.
85+
## Contributors
7586

76-
## Resources
87+
Thank you to the open source community for your contributions and for building this with us!
7788

78-
- [Website](https://flagsmith.com/)
79-
- [Documentation](https://docs.flagsmith.com/)
80-
- If you have any questions about our projects you can email [support@flagsmith.com](mailto:support@flagsmith.com)
89+
<a href="https://github.com/flagsmith/flagsmith/graphs/contributors">
90+
<img src="https://contrib.rocks/image?repo=flagsmith/flagsmith" />
91+
</a>
8192

93+
Made with [contrib.rocks](https://contrib.rocks).

static-files/ReadMe_Demo.gif

9.43 MB
Loading

static-files/flagsmith-cover.png

34.8 KB
Loading

static-files/hero.png

-7.54 KB
Binary file not shown.

0 commit comments

Comments
 (0)