Skip to content

Commit

Permalink
docs: clarify dependency version options in README
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
egegungordu committed Jan 31, 2025
1 parent 945fd23 commit db33876
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit db33876

Please sign in to comment.