Skip to content

Commit 6c0cb1d

Browse files
committed
fix: readme should be updated with release please
1 parent c1dfdc3 commit 6c0cb1d

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ Core algorithms for the [FishSense](https://e4e.ucsd.edu/fishsense) project. The
1515

1616
Add to `Cargo.toml`:
1717

18+
<!-- x-release-please-start-version -->
1819
```toml
1920
[dependencies]
2021
fishsense-core = { git = "https://github.com/UCSD-E4E/fishsense-core", tag = "fishsense-core-v0.8.0" }
2122
```
23+
<!-- x-release-please-end -->
2224

2325
Key types and functions:
2426

@@ -33,13 +35,15 @@ use fishsense_core::world_point_handler::WorldPointHandler;
3335

3436
Add to `pyproject.toml` (requires the Rust toolchain to build):
3537

38+
<!-- x-release-please-start-version -->
3639
```toml
3740
[project]
3841
dependencies = ["fishsense-core"]
3942

4043
[tool.uv.sources]
4144
fishsense-core = { git = "https://github.com/UCSD-E4E/fishsense-core", tag = "fishsense_core-v0.8.0", subdirectory = "python/fishsense_core" }
4245
```
46+
<!-- x-release-please-end -->
4347

4448
Python API:
4549

release-please-config.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@
1111
"packages": {
1212
"rust/fishsense-core": {
1313
"release-type": "rust",
14-
"package-name": "fishsense-core"
14+
"package-name": "fishsense-core",
15+
"extra-files": [
16+
{
17+
"type": "generic",
18+
"path": "/README.md"
19+
}
20+
]
1521
},
1622
"python/fishsense_core": {
1723
"release-type": "rust",

0 commit comments

Comments
 (0)