0.1.0

Author: ModProg

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-02-27
+Initial release
+
+[unreleased]: https://github.com/ModProg/interpolator/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ModProg/interpolator/v0.1.0

Cargo.toml

@@ -1,17 +1,17 @@
 [package]
-name = "template"
+name = "interpolator"
 version = "0.1.0"
 edition = "2021"
-categories = []
-description = ""
-keywords = []
+categories = ["template-engine", "value-formatting", "text-processing"]
+description = "runtime format strings, fully compatible with std's macros"
+keywords = ["text", "interpolation", "format"]
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/ModProg/template"
 documentation = "https://docs.rs/template"
 
 [features]
-default = ["debug", "number", "pointer"]
+# default = ["debug", "number", "pointer"]
 debug = []
 number = []
 pointer = []

README.md

@@ -1,6 +1,55 @@
-# template
+# interpolator
 
-[![CI Status](https://github.com/ModProg/template/actions/workflows/test.yaml/badge.svg)](https://github.com/ModProg/template/actions/workflows/test.yaml)
-[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://modprog.github.io/template/template/)
-<!-- [![Crates.io](https://img.shields.io/crates/v/template)](https://crates.io/crates/template) -->
-<!-- [![Docs.rs](https://img.shields.io/crates/v/template?color=informational&label=docs.rs)](https://docs.rs/template) -->
+[![CI Status](https://github.com/ModProg/interpolator/actions/workflows/test.yaml/badge.svg)](https://github.com/ModProg/interpolator/actions/workflows/test.yaml)
+[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://modprog.github.io/interpolator/interpolator/)
+[![Crates.io](https://img.shields.io/crates/v/interpolator)](https://crates.io/crates/interpolator)
+[![Docs.rs](https://img.shields.io/crates/v/interpolator?color=informational&label=docs.rs)](https://docs.rs/interpolator)
+
+Runtime implementation of `format!`.
+
+# `format`
+Runtime version of `format!`.
+
+Takes a string and a context, containing `Formattable` values, returns a
+string.
+
+```rs
+use template::{format, Formattable};
+
+let formatted = format(
+    "{value:+05}", // could be dynamic
+    &[("value", Formattable::display(&12))].into_iter().collect(),
+)
+.unwrap();
+
+assert_eq!(formatted, format!("{:+05}", 12));
+```
+
+# `write`
+Runtime version of `write!`.
+
+Takes a mutable `Write` e.g. `&mut String`, a format string and a context,
+containing `Formattable` values.
+                                                                            
+```rs
+use template::{write, Formattable};
+                                                                            
+let mut buf = String::new();
+write(
+    &mut buf,
+    "{value:+05}", // could be dynamic
+    &[("value", Formattable::display(&12))].into_iter().collect(),
+)
+.unwrap();
+                                                                            
+assert_eq!(buf, format!("{:+05}", 12));
+```
+
+# Features
+By default only `Display` is supported, the rest of the
+[formatting traits](https://doc.rust-lang.org/std/fmt/index.html#formatting-traits)
+can be enabled through the following features.
+
+- `debug` enables `?`, `x?` and `X?` trait specifiers
+- `number` enables `x`, `X`, `b`, `o`, `e` and `E` trait specifiers
+- `pointer` enables `p` trait specifiers

src/lib.rs

@@ -496,7 +496,7 @@ impl<'a> FormatArgument<'a> {
 
 /// Runtime version of [`write!`].
 ///
-/// Takes a mutable [`Write`] e.g `&mut String`, a format string and a context,
+/// Takes a mutable [`Write`] e.g. `&mut String`, a format string and a context,
 /// containing [`Formattable`] values.
 ///
 /// ```