functype 0.15.0 → 0.17.0

package/README.md

@@ -68,50 +68,11 @@ For detailed optimization strategies, see the [Bundle Optimization Guide](docs/B
 
 ### Option
 
-```typescript
-import { Option, Some, None } from "functype"
-
-// Create options
-const value = Option("hello") // Some("hello")
-const empty = Option(null) // None
-const explicit = Some(42) // Some(42)
-
-// Transform values
-const length = value.map((s) => s.length) // Some(5)
-const nothing = empty.map((s) => s.length) // None
-
-// Handle default values
-const result = value.getOrElse("world") // "hello"
-const fallback = empty.getOrElse("world") // "world"
-
-// Conditionally filter
-const filtered = value.filter((s) => s.length > 10) // None
-```
+{@includeCode test/docs/documentation-examples.spec.ts#readme-option-basic}
 
 ### Either
 
-```typescript
-import { Either, Right, Left } from "functype"
-
-// Success case
-const success = Right<string, number>(42)
-// Error case
-const failure = Left<string, number>("error")
-
-// Transform values (map only applies to Right)
-const doubled = success.map((x) => x * 2) // Right(84)
-const stillError = failure.map((x) => x * 2) // Left("error")
-
-// Handle errors
-const value = success.getOrElse(0) // 42
-const fallback = failure.getOrElse(0) // 0
-
-// Pattern matching with fold
-const result = success.fold(
-  (err) => `Error: ${err}`,
-  (val) => `Success: ${val}`,
-) // "Success: 42"
-```
+{@includeCode test/docs/documentation-examples.spec.ts#readme-either-basic}
 
 ### List
 
@@ -687,6 +648,10 @@ opt.forEach(console.log) // Logs: 42
 list.forEach(console.log) // Logs: 1, 2, 3, 4, 5
 ```
 
+## Feature Matrix
+
+For a comprehensive overview of which interfaces are supported by each data structure, see the [Functype Feature Matrix](docs/FUNCTYPE_FEATURE_MATRIX.md).
+
 ## Type Safety
 
 Functype leverages TypeScript's advanced type system to provide compile-time safety for functional patterns, ensuring that your code is both robust and maintainable.
@@ -835,6 +800,32 @@ For more details, see the [Error Formatting Guide](docs/error-formatting.md).
 - [ ] Implement more type-level utilities (conditional types, template literals)
 - [ ] Leverage newer TypeScript features (const type parameters, tuple manipulation)
 
+## Claude Code Skills
+
+Functype provides two specialized Claude Code skills to enhance your development experience:
+
+### Functype User Guide
+
+Help for developers using functype in their projects:
+
+- Pattern conversion (imperative → functional)
+- API lookup and examples
+- Common use cases and debugging tips
+
+**Install**: Download from [dist/skills/functype-user.zip](./dist/skills/functype-user.zip)
+
+### Functype Library Developer
+
+Guide for contributors developing functype itself:
+
+- Architecture patterns and development workflow
+- Creating new data structures
+- Testing strategies and interface implementation
+
+**Install**: Download from [dist/skills/functype-developer.zip](./dist/skills/functype-developer.zip)
+
+See [.claude/skills/README.md](./.claude/skills/README.md) for complete installation and usage instructions.
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.