From 5e86e2502af0f4b90944478fef2e13e05df820c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20DOUIN?= Date: Tue, 5 Nov 2024 16:10:35 +0100 Subject: [PATCH] adjust docs --- CHANGELOG.md | 19 ++++++++++--------- LICENSE | 2 +- README.md | 14 +++++++++++--- 3 files changed, 22 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4841bca..e89968f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- Bumped all major dependencies. + ## [1.0.0] - 2023-09-27 ### Changed @@ -39,7 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Improved shell expansion. -- Use `clap` derive feature for parsing arguments. [patch#44147] +- Use `clap` derive feature for parsing arguments. ## [0.2.0] - 2023-08-27 @@ -50,7 +54,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Fixed wrong main command name [patch#44036]. +- Fixed wrong main command name. ## [0.1.1] - 2023-08-27 @@ -67,14 +71,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Added `compile` and `interpret` feature from [mml-lib]. - -[mml-lib]: https://crates.io/crates/mml-lib - -[patch#44036]: https://lists.sr.ht/~soywod/pimalaya/patches/44036 -[patch#44147]: https://lists.sr.ht/~soywod/pimalaya/patches/44147 +- Added `compile` and `interpret` feature from [mml-lib](https://crates.io/crates/mml-lib). -[Unreleased]: https://github.com/soywod/mml/compare/v0.2.1...master +[Unreleased]: https://github.com/soywod/mml/compare/v1.0.0...master +[1.0.0]: https://github.com/soywod/mml/compare/v0.3.0...v1.0.0 +[0.3.0]: https://github.com/soywod/mml/compare/v0.2.1...v0.3.0 [0.2.1]: https://github.com/soywod/mml/compare/v0.2.0...v0.2.1 [0.2.0]: https://github.com/soywod/mml/compare/v0.1.1...v0.2.0 [0.1.1]: https://github.com/soywod/mml/compare/v0.1.0...v0.1.1 diff --git a/LICENSE b/LICENSE index 8d8a6b3..52536f3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020-2023 soywod +Copyright (c) 2020-2024 soywod Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index db4d1f8..90329ff 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ CLI to convert [MIME](https://www.rfc-editor.org/rfc/rfc2045) messages into/from ## Installation -MML CLI can be installed with a pre-built binary: +### From release + +MML CLI can be installed with a pre-built binary from the latest [GitHub release](https://github.com/pimalaya/mml/releases): ```bash # As root: @@ -21,9 +23,15 @@ $ curl -sSL https://raw.githubusercontent.com/pimalaya/mml/master/install.sh | s $ curl -sSL https://raw.githubusercontent.com/pimalaya/mml/master/install.sh | PREFIX=~/.local sh ``` -These commands install the latest binary from the GitHub [releases](https://github.com/pimalaya/mml/releases) section. +### From CI + +MML CLI can be installed with a pre-built binary from the [pre-release GitHub workflow](https://github.com/pimalaya/neverest/actions/workflows/pre-release.yml): take the latest build, find the *Artifacts* section, you should find a pre-built binary matching your OS. + +This workflow is triggered everytime a new commit is pushed on `master`. Such binary is usually more up-to-date than a release, but also less stable. + +*Pre-built binaries are built with [default](https://github.com/pimalaya/mml/blob/master/Cargo.toml#L18) cargo features. If you want to enable or disable a feature, please use another installation method.* -*Binaries are built with [default](https://github.com/pimalaya/mml/blob/master/Cargo.toml#L18) cargo features. If you want to enable or disable a feature, please use another installation method.* +### Other
Cargo