Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-way committed Nov 3, 2024
1 parent 82760e6 commit 3cd3136
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Rust Cargo Plugin

This is a plugin for [Universal Changesets](https://github.com/universal-changesets/core) that allows you to get/set the version of your Rust project via the `Cargo.toml` file.

## Usage

To use this plugin, you need to reference it within the `.changeset/config.json` file:

```json
{
"$schema": "https://raw.githubusercontent.com/universal-changesets/core/main/changeset-config.schema.json",
"plugin": {
"sha256": "e63c184c019d2198b497ceeaefeb59587da138ca7f78edc34e21332a7cc4b18c",
"url": "gh:universal-changesets/[email protected]"
}
}
```

Once you've done that, you can use the `changeset get` and `changeset version` functions in your project. Refer to the [documentation](https://github.com/universal-changesets/core/blob/main/docs/plugins.md) for more information.

0 comments on commit 3cd3136

Please sign in to comment.