# Versioning

This versioning documentation specifically refers to the version of the Giterated ABI. The Giterated ABI can, and should, update independently from the rest of the project, as needed.

## Pre 1.0.0 (Now!)

You are able to consume `giterated-abi` in your `Cargo.toml` manifest as follows with the expectation nothing should break as `giterated-abi` updates:
```
giterated-abi = "0.1"
```

It is important to still receive patch updates automatically as we may provide shim functionality and better compatibility with future changes in these updates. There may also be security and performance fixes. Furthermore it allows for Cargo to be more precise when selecting the exact dependency version.

- Stability is **not** guaranteed.
- Breaking changes **can** be made between "minor" semver versions, they **should** be well documented and announced ahead of time.

## Post 1.0.0 (Future)

You are able to consume `giterated-abi` in your `Cargo.toml` manifest as follows with the *guarantee* of compatibility.

```
giterated-abi = "1"
```

After 1.0.0 is released, minor updates **must not** contain changes that violate a reasonable understanding of semver. The ABI is intended to be stable and only changed in a backwards-compatible manner beyond 1.0.0.