From db338763a549141743d904dace29240890baac7f Mon Sep 17 00:00:00 2001 From: Ege Gungordu Date: Fri, 31 Jan 2025 14:55:44 +0300 Subject: [PATCH] docs: clarify dependency version options in README Distinguish between development version from main branch and release versions in the installation instructions. Update section headers and descriptions to help users make an informed choice between using the development version or a stable release. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa2aae9..0bf6130 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,22 @@ This project includes the **IPADIC dictionary**, which is provided under the lic ## Integrating jaime into your Zig Project -You first need to add jaime as a dependency in your `build.zig.zon` file: +You can add jaime as a dependency in your `build.zig.zon` file in two ways: + +### Development Version ```bash +# Get the latest development version from main branch zig fetch --save git+https://github.com/egegungordu/jaime ``` +### Release Version + +```bash +# Get a specific release version (replace x.y.z with desired version) +zig fetch --save https://github.com/egegungordu/jaime/archive/refs/tags/vx.y.z.tar.gz +``` + Then instantiate the dependency in your `build.zig`: ```zig