Skip to content

Commit 9e9027b

Browse files
committed
docs: update /README.md
1 parent d60c3ab commit 9e9027b

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1-
# koka
1+
# Koka - AI-Oriented TypeScript Framework
22

3-
An AI-Oriented TypeScript framework based on Algebraic Effects
3+
Koka is a monorepo containing several packages that provide algebraic effects and domain-driven development capabilities for TypeScript applications.
4+
5+
## Packages
6+
7+
### [koka](packages/koka/) - Core Effects Library
8+
9+
A lightweight 3kB alternative to Effect-TS based on Algebraic Effects
10+
11+
- Typed error handling
12+
- Context management
13+
- Async operations
14+
- Minimal API surface
15+
16+
### [koka-ddd](packages/koka-ddd/) - DDD Framework
17+
18+
An AI-Oriented Domain-Driven Design framework built on Koka
19+
20+
- Algebraic effects for domain modeling
21+
- Optics integration
22+
- CQRS patterns
23+
24+
### [koka-domain](packages/koka-domain) - Data Accessors
25+
26+
Bidirectional data accessors with optics
27+
28+
- Type-safe data transformations
29+
- Lens/prism support
30+
- Effectful data operations
31+
- Composable access patterns
32+
33+
## Documentation
34+
35+
- [Koka Core Documentation](packages/koka/README.md)
36+
- [Koka DDD Documentation](packages/koka-ddd/README.md)
37+
- [Koka Domain Documentation](packages/koka-domain/README.md)
38+
39+
## Contributing
40+
41+
We welcome contributions! Please see our [Contribution Guidelines](CONTRIBUTING.md).
42+
43+
## License
44+
45+
MIT

0 commit comments

Comments
 (0)