Link to crates.io, changelog boilerplate, formatting

CHANGELOG.md

@@ -1,5 +1,12 @@
 # SpamAssassin Milter changelog
 
+All notable user-facing changes are listed in this changelog.
+
+This project follows Rust-flavoured [semantic versioning], with changes to the
+minimum supported Rust version being considered breaking changes.
+
+[semantic versioning]: https://doc.rust-lang.org/cargo/reference/semver.html
+
 ## 0.4.0 (2023-01-29)
 
 The minimum supported Rust version is now 1.61.0.

README.md

@@ -39,7 +39,8 @@ Postfix, and for delivery [Dovecot] with LMTP and the [Sieve plugin].
 ## Installation
 
 SpamAssassin Milter is a [Rust] project. It can be installed using Cargo as
-usual:
+usual. For example, use the following command to install the latest version
+published on [crates.io]:
 
 ```
 cargo install --locked spamassassin-milter
@@ -53,6 +54,7 @@ path when building the application.
 The minimum supported Rust version is 1.61.0.
 
 [Rust]: https://www.rust-lang.org
+[crates.io]: https://crates.io/crates/spamassassin-milter
 
 ## Usage
 
@@ -263,4 +265,4 @@ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License along with
-this program. If not, see https://www.gnu.org/licenses/.
+this program. If not, see <https://www.gnu.org/licenses/>.

src/callbacks.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use crate::{
     client::{Client, ReceivedInfo, Spamc},

src/client.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use crate::{
     config::Config,

src/collections.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use std::mem;
 

src/config.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use ipnet::IpNet;
 use std::{collections::HashSet, net::IpAddr};

src/email.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use crate::{
     collections::{StrVecMap, StrVecSet},

src/error.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use indymilter::{ActionError, SmtpReplyError};
 use std::{

src/lib.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 //! The SpamAssassin Milter application library.
 //!

src/main.rs

@@ -12,7 +12,7 @@
 // details.
 //
 // You should have received a copy of the GNU General Public License along with
-// this program. If not, see https://www.gnu.org/licenses/.
+// this program. If not, see <https://www.gnu.org/licenses/>.
 
 use futures::stream::StreamExt;
 use indymilter::Listener;