Skip to content

Commit 2afdc1c

Browse files
committed
update readme
1 parent a5521de commit 2afdc1c

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,46 @@ The indexer built on top of Lake Framework that watches the network and stores t
2727

2828
The configuration module is responsible for managing the configuration settings of the NEAR ReadRPC project.
2929

30+
### [database](database/README.md)
31+
32+
The database module provides database abstractions and implementations for storing and retrieving data.
33+
34+
### [cache-storage](cache-storage/README.md)
35+
36+
The cache storage module provides caching functionality for improved performance.
37+
38+
### [tx-details-storage](tx-details-storage/README.md)
39+
40+
The transaction details storage module handles storage of detailed transaction information.
41+
42+
### [logic-state-indexer](logic-state-indexer/README.md)
43+
44+
The logic state indexer module provides state indexing functionality.
45+
46+
### [readnode-primitives](readnode-primitives/README.md)
47+
48+
The readnode primitives module contains common data structures and utilities.
49+
50+
### [perf-testing](perf-testing/README.md)
51+
52+
The performance testing module provides tools for testing and benchmarking.
53+
54+
## Documentation
55+
56+
### Project Documentation
57+
- [CHANGELOG.md](CHANGELOG.md) - Project changelog and version history
58+
- [Examples](examples/README.md) - Usage examples and sample configurations
59+
60+
### Technical Documentation
61+
- [RPC Methods](docs/RPC_METHODS.md) - Available RPC methods and their specifications
62+
- [Custom RPC Methods](docs/CUSTOM_RPC_METHODS.md) - Custom RPC methods specific to Read RPC
63+
- [Database Migrations](docs/DATABASE_MIGRATIONS.md) - Database migration procedures and guidelines
64+
- [Tracing](docs/TRACING.md) - Distributed tracing setup and configuration
65+
66+
### Database Documentation
67+
- [PostgreSQL Setup](database/src/postgres/README.md) - PostgreSQL-specific configuration and setup
68+
- [Database Migrations](docs/DATABASE_MIGRATIONS.md) - Database migration procedures and guidelines
69+
3070
## Docker compose
3171

3272
**Note!** The docker compose is not fully ready yet. It's still in progress. However, you can run the entire project to play around with it. It is still not convenient for development or debugging purposes. We are working on improving it.

0 commit comments

Comments
 (0)