Skip to content

Commit 92035d1

Browse files
committed
Update README
1 parent 5d86d19 commit 92035d1

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In Cargo.toml add
1616

1717
```toml
1818
[dependencies]
19-
edit-distance = "2.1.2"
19+
edit-distance = "2.1.3"
2020
```
2121

2222
Then re-run `cargo build`. That fetches the dependencies and builds
@@ -41,12 +41,23 @@ cargo build
4141
cargo test
4242
```
4343

44-
## Contributing
44+
## Release
4545

46-
Before sending a pull-request that goes beyond a bugfix, please open an issue to discuss. PRs without clear objective or separation of concerns aren't likely to be accepted.
46+
- change Cargo.toml version
47+
- change install instructions (version)
48+
- update History section
49+
- commit with version as comment
50+
- tag with version, then:
51+
52+
```shell
53+
cargo publish
54+
git push
55+
git push --tags
56+
```
4757

4858
## History
4959

60+
2024-09-04 2.1.3 Update dev-dependency
5061
2024-06-26 2.1.2 Fix formatting
5162
2024-06-26 2.1.1 Replace CI badge, maintenance
5263
2019-03-02 2.1.0 Optimize memory usage
@@ -55,6 +66,10 @@ Before sending a pull-request that goes beyond a bugfix, please open an issue to
5566
2015-05-01 1.0.0 Release
5667
2015-04-18 0.0.1 Initial upload
5768

69+
## Contributing
70+
71+
Before sending a pull-request that goes beyond a bugfix, please open an issue to discuss. PRs without clear objective or separation of concerns aren't likely to be accepted.
72+
5873
## Credits
5974

6075
Thanks to @skade for very helpful criticism of my first rust lib.

0 commit comments

Comments
 (0)