Skip to content

Commit

Permalink
adjust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
soywod committed Nov 5, 2024
1 parent f335a75 commit 5e86e25
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 13 deletions.
19 changes: 10 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020-2023 soywod <clement.douin@posteo.net>
Copyright (c) 2020-2024 soywod <clement.douin@posteo.net>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

<details>
<summary>Cargo</summary>
Expand Down

0 comments on commit 5e86e25

Please sign in to comment.