From 5a3f615fd304b23dcf82c83b719769443bf28f57 Mon Sep 17 00:00:00 2001 From: Saint Date: Fri, 18 Oct 2024 23:19:52 +0100 Subject: [PATCH 1/3] Enhanced README.md with additional details and clarity --- README.md | 49 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b3d71c6..bd913fe 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,51 @@ +```markdown # da-codec -Scroll's DA encoding/decoding libraries. +Scroll's DA (Data-Aware) encoding and decoding libraries provide efficient serialization and transmission mechanisms suitable for various applications in data handling. -## Running unit tests -``` +## Getting Started + +To use the DA codec library in your project, follow these steps: + +1. Install Go on your machine if you haven't already: [Installing Go](https://golang.org/doc/install). +2. Clone this repository: + ```bash + git clone https://github.com/saintmoritzz/da-codec.git + ``` +3. Navigate to the project directory: + ```bash + cd da-codec + ``` +4. Import the library in your Go project: + ```go + import "path/to/your/da-codec" + ``` + +5. Use the encoding and decoding functions as needed in your application. + +## Running Unit Tests + +To ensure code integrity, run the following command: +```bash go test -v -race ./... ``` +Make sure you have Go installed on your system. This command runs all tests in the project with verbose output and race condition detection. ## FAQ -**Q: Why the repo contains `libscroll_zstd*.a` binary files?** +**Q: Why does the repo contain `libscroll_zstd*.a` binary files?** +A: This simplifies package installation with `go get` without the need to perform additional steps for building the `libscroll_zstd*.a` files. -A: This simplifies package installation with `go get` without the need to perform additional steps for building the `libscroll_zstd*.a`. +**Q: Which platforms/architectures are supported?** +A: `linux/amd64`, `linux/arm64`, `darwin/arm64`. Pull requests for other platforms/architectures are welcome. -**Q: Which platforms/architectures are supported?** - -A: `linux/amd64`, `linux/arm64`, `darwin/arm64`. Pull requests for other platforms/architectures are accepted. +**Q: I don't trust `libscroll_zstd*.a` binary files from the repo or these files don't work on my OS/ARCH. How can I rebuild them?** +A: Run the following command if your OS/ARCH is supported: +```bash +cd libzstd && make libzstd +``` -**Q: I don't trust `libscroll_zstd*.a` binary files from the repo or these files don't work on my OS/ARCH. How to rebuild them?** +## Contributing -A: Just run `cd libzstd && make libzstd` if your OS/ARCH is supported. +We welcome contributions to the `da-codec` library! If you have suggestions for improvements or find bugs, please feel free to open an issue or submit a pull request. Ensure you follow the coding standards and include relevant tests for your changes. +``` \ No newline at end of file From d55d27896cc2eb71af97a9324adfb3253a76ae21 Mon Sep 17 00:00:00 2001 From: saint_moritzz <91414937+saintmoritzz@users.noreply.github.com> Date: Fri, 18 Oct 2024 23:55:33 +0100 Subject: [PATCH 2/3] Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index bd913fe..fd453d6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ To use the DA codec library in your project, follow these steps: 1. Install Go on your machine if you haven't already: [Installing Go](https://golang.org/doc/install). 2. Clone this repository: ```bash - git clone https://github.com/saintmoritzz/da-codec.git + git clone https://github.com/scroll-tech/da-codec.git ``` 3. Navigate to the project directory: ```bash @@ -22,7 +22,6 @@ To use the DA codec library in your project, follow these steps: ``` 5. Use the encoding and decoding functions as needed in your application. - ## Running Unit Tests To ensure code integrity, run the following command: From f0a45d5e0513b4e956a167d33bcf61b316465b8f Mon Sep 17 00:00:00 2001 From: Saint Date: Sat, 19 Oct 2024 00:21:40 +0100 Subject: [PATCH 3/3] Fix markdown issue by adding language specifier to code block --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd453d6..21331d4 100644 --- a/README.md +++ b/README.md @@ -47,4 +47,4 @@ cd libzstd && make libzstd ## Contributing We welcome contributions to the `da-codec` library! If you have suggestions for improvements or find bugs, please feel free to open an issue or submit a pull request. Ensure you follow the coding standards and include relevant tests for your changes. -``` \ No newline at end of file +```markdown \ No newline at end of file