Skip to content

Commit bbbc410

Browse files
committed
updating readme
1 parent f19bb1c commit bbbc410

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# <img src="https://github.com/dzhibas/flagfile/blob/main/public/ff.png?raw=true" width=50px/> Flagfile
22

3+
![Build and Tests](https://github.com/dzhibas/flagfile/actions/workflows/rust.yml/badge.svg)
4+
35
it's developer friendly feature flagging solution where you define all your flags in Flagfile in this format: [Flagfile.example](Flagfile.example)
46

57
its boolean expression parser library which was initially written in pest.rs (https://github.com/dzhibas/bool_expr_parser) and later rewrote everything in Nom rust lib
@@ -32,10 +34,11 @@ FF-feature-flat-on-off -> true
3234
FF-feature-json-variant -> json({"success": true})
3335

3436
// features are forced to start with FF- case-sensitive as
35-
// it allows you later to find all flags through in codebase
37+
// it allows you later to find all flags through the codebase
3638
FF-feature-name-specifics -> false
3739

38-
// you can have feature with multiple rules in it with default flag value returned in end
40+
// you can have feature with multiple rules in it with default flag value returned in the end
41+
// you can have comments or comment blocks with // or /* comment */
3942
FF-feature-y {
4043
// if country is NL return True
4144
countryCode == NL: true
@@ -49,7 +52,8 @@ FF-testing {
4952
json({"success": true})
5053
}
5154

52-
// and have more complex feature with multiple rules in it, which at the end defaults to false
55+
// and have more complex feature with multiple rules in it and some rules multiline rule, which at the end defaults to false
56+
// aswel capitalize for visibility boolean TRUE/FALSE
5357
FF-feature-complex-ticket-234234 {
5458
// complex bool expression
5559
a = b and c=d and (dd not in (1,2,3) or z == "demo car"): TRUE

0 commit comments

Comments
 (0)