Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme based on docs changes #60

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,44 @@
# ConfigCat Feature Flags Trello Power-Up

Turn features On / Off right from a linked Card on your Trello board. Also you can add Targeting or Percentage Rules just as easily.
The [ConfigCat's Trello Power-Up](https://trello.com/power-ups/5e694b66d2511a3601ebd0fb) allows you to connect your Trello Cards and feature flags. Create or link existing flags to your Trello cards without leaving your Trello board.

Turn features On/Off right from a linked card on your Trello board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules.

## About ConfigCat

Manage features and change your software configuration using [ConfigCat feature flags](https://configcat.com), without the need to re-deploy code. A [10 minute trainable Dashboard](https://app.configcat.com) allows even non-technical team members to manage features directly. Deploy anytime, release when confident. Target a specific group of users first with new ideas. Supports A/B/n testing and soft launching. Provides [open-source SDKs](https://github.com/configcat) for easy integration with any web, mobile or backend application.

## Installation
<img src="https://raw.githubusercontent.com/configcat/trello-powerup/master/src/assets/enable_trello.gif" alt="Installation of the ConfigCat Feature Flags Trello Power-Up" width="640"/>

1. Add ConfigCat Power-Up to your board.
1. Add [ConfigCat Power-Up](https://trello.com/power-ups/5e694b66d2511a3601ebd0fb) to your board.
2. Select `Settings -> Authorize Account`.
3. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials
4. Click authorize.

<img src="https://raw.githubusercontent.com/configcat/trello-powerup/master/src/assets/install.gif" alt="Installation of the ConfigCat Feature Flags Trello Power-Up" width="640"/>

## Usage
<img src="https://raw.githubusercontent.com/configcat/trello-powerup/master/src/assets/use_trello.gif" alt="Usage of the ConfigCat Feature Flags Trello Power-Up" width="640"/>

### Linking existing feature flags

1. Open any Card on your Trello board.
2. Push `Link Feature Flag`
3. Select a Product, Config, Environment and a Feature Flag to be linked to your card.
3. Select a ConfigCat Product, Config, Environment and a Feature Flag to be linked to your card.
4. When linked, you can turn your features On / Off right from this Card.

<img src="https://raw.githubusercontent.com/configcat/trello-powerup/master/src/assets/link-existing.gif" alt="Usage of the ConfigCat Feature Flags Trello Power-Up" width="640"/>

### Creating new feature flags

1. Open any Card on your Trello board.
2. Push the `Create and Link Feature Flag` button.
3. Select a ConfigCat Product and Config where you want to create the feature flag.
4. Set up your feature flag.
5. Select which environment you would like to link to this item.
6. When linked, you can manage the selected feature flag from this Card.

<img src="https://raw.githubusercontent.com/configcat/trello-powerup/master/src/assets/create-link.gif" alt="Usage of the ConfigCat Feature Flags Trello Power-Up" width="640"/>

## Run project locally
1. Install npm dependencies
```
Expand Down
Binary file added src/assets/create-link.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/assets/enable_trello.gif
Binary file not shown.
Binary file added src/assets/install.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/link-existing.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/assets/use_trello.gif
Binary file not shown.