Commit f0fe238
docs: update README to reflect instance-based API refactoring (#53)
Updated documentation to match the new architecture:
- Features: Replaced "Flag State Management" with "Instance-Based API"
and added "Type-Specific Evaluation" to highlight new capabilities
- Rust Usage: Completely rewrote example to use FlagEvaluator instead of
deleted storage module and evaluation functions
- API Reference: Added type-specific evaluation functions
(evaluate_boolean, evaluate_string, evaluate_integer, evaluate_float,
evaluate_object)
- Validation Modes: Updated to show per-instance validation mode instead
of global storage module approach
All examples now accurately reflect the current codebase after the
storage module removal and FlagEvaluator refactoring.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
## Description
<!-- Provide a brief description of your changes -->
## Related Issue
<!-- Link to the related issue(s) -->
Closes #
## Type of Change
<!-- Mark the relevant option with an "x" -->
- [ ] `feat`: New feature (minor version bump)
- [ ] `fix`: Bug fix (patch version bump)
- [ ] `docs`: Documentation only changes
- [ ] `chore`: Maintenance tasks, dependency updates
- [ ] `refactor`: Code refactoring without functional changes
- [ ] `test`: Adding or updating tests
- [ ] `ci`: CI/CD changes
- [ ] `perf`: Performance improvements
- [ ] `build`: Build system changes
- [ ] `style`: Code style/formatting changes
## PR Title Format
**IMPORTANT**: Since we use squash and merge, your PR title will become
the commit message. Please ensure your PR title follows the
[Conventional Commits](https://www.conventionalcommits.org/) format:
```
<type>(<optional-scope>): <description>
```
### Examples:
- `feat(operators): add new string comparison operator`
- `fix(wasm): correct memory allocation bug`
- `docs: update API examples in README`
- `chore(deps): update rust dependencies`
For breaking changes, use `!` after the type/scope or include `BREAKING
CHANGE:` in the PR description:
- `feat(api)!: redesign evaluation API`
## Testing
<!-- Describe the testing you've performed -->
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed
- [ ] All tests pass (`cargo test`)
- [ ] Code is formatted (`cargo fmt`)
- [ ] Clippy checks pass (`cargo clippy -- -D warnings`)
- [ ] WASM builds successfully (if applicable)
## Breaking Changes
<!-- If this introduces breaking changes, describe them here -->
- [ ] This PR includes breaking changes
- [ ] Documentation has been updated to reflect breaking changes
- [ ] Migration guide included (if needed)
## Additional Notes
<!-- Any additional information, context, or screenshots -->
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>1 parent 948adcd commit f0fe238
1 file changed
Lines changed: 60 additions & 22 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
14 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
15 | 16 | | |
16 | 17 | | |
17 | 18 | | |
| |||
464 | 465 | | |
465 | 466 | | |
466 | 467 | | |
| 468 | + | |
| 469 | + | |
467 | 470 | | |
468 | | - | |
469 | | - | |
| 471 | + | |
470 | 472 | | |
471 | 473 | | |
472 | | - | |
473 | | - | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
474 | 479 | | |
475 | 480 | | |
476 | 481 | | |
477 | 482 | | |
478 | | - | |
| 483 | + | |
| 484 | + | |
| 485 | + | |
| 486 | + | |
| 487 | + | |
| 488 | + | |
| 489 | + | |
| 490 | + | |
479 | 491 | | |
480 | 492 | | |
481 | | - | |
| 493 | + | |
482 | 494 | | |
483 | | - | |
| 495 | + | |
484 | 496 | | |
485 | | - | |
486 | | - | |
487 | | - | |
488 | | - | |
| 497 | + | |
| 498 | + | |
| 499 | + | |
489 | 500 | | |
490 | | - | |
491 | | - | |
492 | | - | |
| 501 | + | |
| 502 | + | |
| 503 | + | |
| 504 | + | |
| 505 | + | |
| 506 | + | |
493 | 507 | | |
494 | 508 | | |
| 509 | + | |
| 510 | + | |
| 511 | + | |
| 512 | + | |
| 513 | + | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
495 | 519 | | |
496 | 520 | | |
497 | 521 | | |
498 | 522 | | |
499 | 523 | | |
500 | 524 | | |
501 | 525 | | |
502 | | - | |
| 526 | + | |
| 527 | + | |
| 528 | + | |
| 529 | + | |
| 530 | + | |
| 531 | + | |
503 | 532 | | |
504 | 533 | | |
505 | 534 | | |
| |||
831 | 860 | | |
832 | 861 | | |
833 | 862 | | |
| 863 | + | |
| 864 | + | |
| 865 | + | |
834 | 866 | | |
835 | | - | |
| 867 | + | |
836 | 868 | | |
837 | | - | |
838 | | - | |
| 869 | + | |
| 870 | + | |
839 | 871 | | |
840 | | - | |
841 | | - | |
| 872 | + | |
| 873 | + | |
| 874 | + | |
| 875 | + | |
| 876 | + | |
| 877 | + | |
842 | 878 | | |
843 | 879 | | |
844 | 880 | | |
| 881 | + | |
| 882 | + | |
845 | 883 | | |
846 | 884 | | |
847 | 885 | | |
| |||
0 commit comments