Skip to content

Commit 24bc452

Browse files
docs: Final touches to README before v1
1 parent cf69835 commit 24bc452

File tree

1 file changed

+10
-18
lines changed

1 file changed

+10
-18
lines changed

README.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def application do
4242

4343
### Application Customization
4444

45-
This library includes `Posthog.Application` because we bundle `Cachex` to avoid you from being charged too often for feature-flag checks against the same `{flag, distinct_id}` tuple.
45+
This library includes a `Posthog.Application` because we bundle `Cachex` to allow you to track inside PostHog your FF usage.
4646

4747
This cache is located under `:posthog_feature_flag_cache`. If you want more control over the application, you can init it yourself in your own `application.ex`
4848

@@ -76,13 +76,13 @@ config :posthog,
7676

7777
# Optional configurations
7878
config :posthog,
79-
json_library: Jason, # Default JSON parser (optional)
80-
enabled: true, # Whether to enable PostHog tracking (optional, defaults to true)
79+
json_library: Jason, # Default JSON parser (optional)
80+
capture_enabled: true, # Whether to enable PostHog tracking (optional, defaults to true)
8181
http_client: Posthog.HTTPClient.Hackney, # Default HTTP client (optional)
82-
http_client_opts: [ # HTTP client options (optional)
83-
timeout: 5_000, # Request timeout in milliseconds (default: 5_000)
84-
retries: 3, # Number of retries on failure (default: 3)
85-
retry_delay: 1_000 # Delay between retries in milliseconds (default: 1_000)
82+
http_client_opts: [ # HTTP client options (optional)
83+
timeout: 5_000, # Request timeout in milliseconds (default: 5_000)
84+
retries: 3, # Number of retries on failure (default: 3)
85+
retry_delay: 1_000 # Delay between retries in milliseconds (default: 1_000)
8686
]
8787
```
8888

@@ -308,29 +308,21 @@ This project uses several development tools to maintain code quality and securit
308308
Credo is a static code analysis tool that helps enforce coding standards and catch potential issues. Run it with:
309309

310310
```bash
311-
mix credo
311+
mix credo --strict
312312
```
313313

314314
For more detailed output:
315315

316316
```bash
317-
mix credo --verbose
317+
mix credo --strict --verbose
318318
```
319319

320320
### Mix Audit
321321

322322
Mix Audit helps identify security vulnerabilities in dependencies. Run it with:
323323

324324
```bash
325-
mix audit
326-
```
327-
328-
### Mix Unused
329-
330-
Mix Unused helps identify unused code in your project. Run it with:
331-
332-
```bash
333-
mix unused
325+
mix deps.audit
334326
```
335327

336328
## Contributing

0 commit comments

Comments
 (0)