docs updates, deprecation warning

Author: atuttle

CONTRIBUTING.md

@@ -25,8 +25,9 @@ If you already have something using port 80, the tests won't work. You can eithe
 Once the server is running, if you prefer viewing the tests in a browser, they can be found at: http://localhost/runner.cfm
 
 On the CLI:
- - `$ box testbox run` does a one-time run
- - `$ box testbox watch` will re-run the tests when relevant files are saved
+
+- `$ box testbox run` does a one-time run
+- `$ box testbox watch` will re-run the tests when relevant files are saved
 
 I've also included a Makefile with some helpful aliases for managing the test server, and running tests
 

README.md

@@ -10,12 +10,6 @@ A minimalist Feature Flag engine for CFML apps
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
-> #### ⚠️ UNPROVEN! DANGER! ⚠️
->
-> I've only _just_ put this into production in my company's product. So far so good, but it's a sample size of 1 and a test duration measured in days. (29 Jul 2021)
->
-> For what it's worth, we've got good tests and they pass. Use at your own risk. 🤷‍♂️
-
 ### Minimalist? What's included?
 
 - Rules engine
@@ -138,8 +132,8 @@ This is likely to change, but for now here's what they look like:
 
 ### Flag Rule Types
 
-- `%` "Percentage": A random % of users are in the active segment
-- `filter` "Filter": You specify an attribute from the userAttributes object, and a comparison value and operator, and anyone who passes the comparison is in the active segment (flag is ON for them)
+- `%` "Percentage": X% of users are selected at random to have the feature enabled.
+- `filter` "Filter": You specify an `attribute` from the userAttributes object, the `operator` and a `comparator` (comparison value), and anyone who passes the comparison is in the active segment (flag is ON for them)
 - `nobody`: Flag is OFF for all users
 - `everybody`: Flag is ON for all users
 - More TBD? If you have ideas, [hit me up!](https://github.com/atuttle/semaphore/issues)
@@ -150,13 +144,13 @@ Flags can have multiple rules. At present, Semaphore only supports flag-wide AND
 
 The default is `ANY`. If you want to require all rules match, set `matchRules: 'ALL'` on your flag.
 
-# Why not just use config settings?
+> **Deprecation warning:** In version 1.x the `matchRules` property will be removed in support of [better and/or support](https://adamtuttle.codes/blog/2022/semaphore-0.3-and-1.0/).
 
-You could do that, sure. But the value proposition of feature flags is that they can be toggled independendtly of deploying code changes to your application, and often much more rapidly. They can take effect as quickly as you can update the flag state on your application.
+# Why not just use config settings?
 
-(How you do that is left as an exercise for you. Once I've implemented it in my app I'll probably blog about how I did it and link to that blog post from here.)
+You could do that, sure. But the value proposition of feature flags is that they can be toggled independendtly of deploying code changes to your application, and often much more rapidly. They can take effect as quickly as you can update the flag state on your application. How you do that is left as an exercise for you.
 
-ALSO, feature flags allow you to dynamically segment the user population. As seen above, I've already got support for %-based rollouts, as well as specific user-attribute and environment-attribute filtering.
+ALSO, feature flags allow you to dynamically segment the user population. As seen above, I've already got support for %-based rollouts, as well as specific user-attribute and environment-attribute filtering. Those would be _possible_ to implement with config settings, but probably not worth the effort.
 
 # Why roll your own?
 

box.json

@@ -1,45 +1,45 @@
 {
-  "name": "semaphore",
-  "version": "0.1.0",
-  "author": "Adam Tuttle <https://adamtuttle.codes>",
-  "location": "ForgeboxStorage",
-  "homepage": "https://github.com/atuttle/semaphore",
-  "documentation": "https://github.com/atuttle/semaphore",
-  "repository": {
-    "type": "git",
-    "URL": "https://github.com/atuttle/semaphore"
-  },
-  "bugs": "",
-  "slug": "semaphore",
-  "shortDescription": "A minimalist feature flags engine for CFML applications",
-  "description": "A minimalist feature flags engine for CFML applications",
-  "instructions": "See README.md",
-  "changelog": "",
-  "type": "modules",
-  "keywords": ["feature flags", "flag", "flags", "deploy"],
-  "private": false,
-  "license": [
-    {
-      "type": "MIT",
-      "URL": "https://github.com/atuttle/semaphore/blob/main/LICENSE.md"
-    }
-  ],
-  "contributors": ["Adam Tuttle <https://adamtuttlecodes.com>"],
-  "dependencies": {},
-  "devDependencies": {
-    "testbox": "^4.2.1+400"
-  },
-  "installPaths": {
-    "testbox": "tests/testbox/"
-  },
-  "scripts": {},
-  "ignore": ["**/.*", "/test/", "/tests/"],
-  "testbox": {
-    "runner": [
-      {
-        "default": "http://localhost/runner.cfm"
-      }
-    ],
-    "directory": "tests.specs"
-  }
+	"name": "semaphore",
+	"version": "0.3.0",
+	"author": "Adam Tuttle <https://adamtuttle.codes>",
+	"location": "ForgeboxStorage",
+	"homepage": "https://github.com/atuttle/semaphore",
+	"documentation": "https://github.com/atuttle/semaphore",
+	"repository": {
+		"type": "git",
+		"URL": "https://github.com/atuttle/semaphore"
+	},
+	"bugs": "",
+	"slug": "semaphore",
+	"shortDescription": "A minimalist feature flags engine for CFML applications",
+	"description": "A minimalist feature flags engine for CFML applications",
+	"instructions": "See README.md",
+	"changelog": "",
+	"type": "modules",
+	"keywords": ["feature flags", "flag", "flags", "deploy"],
+	"private": false,
+	"license": [
+		{
+			"type": "MIT",
+			"URL": "https://github.com/atuttle/semaphore/blob/main/LICENSE.md"
+		}
+	],
+	"contributors": ["Adam Tuttle <https://adamtuttlecodes.com>"],
+	"dependencies": {},
+	"devDependencies": {
+		"testbox": "^4.2.1+400"
+	},
+	"installPaths": {
+		"testbox": "tests/testbox/"
+	},
+	"scripts": {},
+	"ignore": ["**/.*", "/test/", "/tests/"],
+	"testbox": {
+		"runner": [
+			{
+				"default": "http://localhost/runner.cfm"
+			}
+		],
+		"directory": "tests.specs"
+	}
 }