Skip to content

Commit 7b2f479

Browse files
authored
Create README.md
1 parent cea8920 commit 7b2f479

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

datasource/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# W3bstream Supported Data Availability (DA) Infra
2+
This folder contains the necessary components and interfaces to support DA infrastructure in W3bstream.
3+
4+
## Contents
5+
6+
- **[DA Interface](./datasource.go):** Defines the interface for Data Availability implementations.
7+
- **[Example Implementation (Postgres)](./postgres.go):** A sample implementation of the DA interface using Postgres.
8+
9+
## Contributing
10+
11+
We welcome contributions to expand the range of Data Availability implementations supported by W3bstream. If you have developed a new implementation, please follow these steps to contribute:
12+
13+
1. **Fork the Repository**: Create a personal copy of the repository by forking it.
14+
2. **Create a Branch**: Create a new branch for your implementation.
15+
3. **Implement and Test**: Develop your implementation and ensure it passes all tests.
16+
4. **Submit a Pull Request (PR)**: Once your implementation is complete, submit a PR to the main repository.
17+
18+
We will review your PR and merge it upon approval. Thank you for contributing to W3bstream!
19+
20+
## Getting Started
21+
22+
To get started with the existing implementations, you can explore the [`datasource.go`](./datasource.co) and [`postgres.go`](./postgres.go) files for interface definitions and examples.
23+
24+
## Contact
25+
26+
For any questions or support, please reach out to our team on [Discord](https://iotex.io/devdiscord) or open an issue in this repository.
27+

0 commit comments

Comments
 (0)