Skip to content

Commit 5fb9262

Browse files
committed
docs: basic information and add coming soon message
1 parent 25c0895 commit 5fb9262

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

β€ŽREADME.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
# can-it.github.io
1+
# CanIt
2+
3+
![Overview](./assets/overview.png)
4+
5+
πŸš€πŸš€πŸš€ **Coming Soon: Full Documentation** πŸš€πŸš€πŸš€
6+
7+
We're excited to share that CanIt supports a variety of packages to enhance your experience. Here are the core packages and utilities currently available:
8+
9+
## Core Packages
10+
- **[@can-it/core](https://www.npmjs.com/package/@can-it/core):** This is the core package that forms the foundation of CanIt.
11+
12+
#### Operators
13+
- **[@can-it/operators-exact](https://www.npmjs.com/package/@can-it/operators-exact):** Provides exact matching comparator.
14+
- **[@can-it/operators-relation](https://www.npmjs.com/package/@can-it/operators-relation):** Provides exact matching comparator and its generator.
15+
- **[@can-it/operators-nested](https://www.npmjs.com/package/@can-it/operators-nested):** Enables nested structure matching comparator.
16+
17+
## Utilization Packages
18+
- **[@can-it/ngx](https://www.npmjs.com/package/@can-it/ngx):** Integration package for Angular applications.
19+
- **[@can-it/react](https://www.npmjs.com/package/@can-it/react):** Integration package for React applications.
20+
21+
πŸ“š More detailed documentation, including usage guides, examples, and advanced features, is currently in the works. We appreciate your patience and encourage you to check back soon for a comprehensive resource to help you make the most out of CanIt. Stay tuned!

β€Žassets/overview.png

3.27 MB
Loading

0 commit comments

Comments
Β (0)