Skip to content

Commit

Permalink
Version 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
wezm committed Apr 1, 2024
1 parent eb1f94c commit efd406a
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 20 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "titlecase"
description = "A tool and library that capitalizes text according to a style defined by John Gruber for post titles on his website Daring Fireball."
version = "2.2.1"
description = "Capitalize text according to a style defined by John Gruber for Daring Fireball."
version = "3.0.0"
edition = "2021"
authors = ["Wesley Moore <[email protected]>"]
rust-version = "1.70.0"
Expand Down
8 changes: 8 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Changelog
=========

## [3.0.0](https://github.com/wezm/titlecase/releases/tag/v3.0.0)

- Update regex dependency [#20](https://github.com/wezm/titlecase/pull/20).
Slim down `regex` crate default features.
- Remove joinery dependency [#19](https://github.com/wezm/titlecase/pull/19)
- Use OnceLock instead of LazyStatic [#18](https://github.com/wezm/titlecase/pull/18)
- Minimum Supported Rust Version is now 1.70.0 [#17](https://github.com/wezm/titlecase/pull/17)

## [2.2.0](https://github.com/wezm/titlecase/releases/tag/v2.2.0)

- Further reduce allocations and optimise regex use
Expand Down
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ by Rust including Linux, macOS, FreeBSD, NetBSD, OpenBSD, and Windows.
[![Build Status](https://api.cirrus-ci.com/github/wezm/titlecase.svg)](https://cirrus-ci.com/github/wezm/titlecase)
[![crates.io](https://img.shields.io/crates/v/titlecase.svg)](https://crates.io/crates/titlecase)
[![Documentation](https://docs.rs/titlecase/badge.svg)][crate-docs]
[![License](https://img.shields.io/crates/l/titlecase.svg)][MIT]

`titlecase` is licensed under the [MIT license][MIT].
## Command Line Usage

`titlecase` reads lines of text from **stdin** and prints title cased versions
to **stdout**.

## Examples
### Examples

```
% echo 'Being productive on linux' | titlecase
Expand All @@ -24,25 +28,33 @@ Finding an Alternative to Mac OS X — Part 2
An Example With Small Words and Sub-Phrases: "The Example"
```

## Command Line Usage
## Install

`titlecase` reads lines of text from **stdin** and prints title cased versions
to **stdout**.
### Pre-compiled binaries

## Usage as a Rust Crate
Pre-compiled binaries are available for a some platforms:

See the [crate documentation][crate-docs].
* [FreeBSD 13+ amd64](https://releases.wezm.net/titlecase/3.0.0/titlecase-3.0.0-amd64-unknown-freebsd.tar.gz)
* [Linux x86\_64](https://releases.wezm.net/titlecase/3.0.0/titlecase-3.0.0-x86_64-unknown-linux-musl.tar.gz)
* [MacOS Universal](https://releases.wezm.net/titlecase/3.0.0/titlecase-3.0.0-universal-apple-darwin.tar.gz)
* [Windows x86\_64](https://releases.wezm.net/titlecase/3.0.0/titlecase-3.0.0-x86_64-pc-windows-msvc.zip)

## Building
Example to download and extract a binary:

**Minimum Supported Rust Version:** 1.70.0
curl https://releases.wezm.net/titlecase/3.0.0/titlecase-3.0.0-x86_64-unknown-linux-musl.tar.gz | tar zxf -

If you have a stable Rust compiler toolchain installed you can install
the most recently released `titlecase` with cargo:
### From Source

```
% cargo install titlecase
```
If you have a stable [Rust compiler toolchain][rustup] installed you can
install the most recently released `titlecase` with cargo:

cargo install titlecase

## Usage as a Rust Crate

**Minimum Supported Rust Version:** 1.70.0

See the [crate documentation][crate-docs].

## Style

Expand All @@ -62,9 +74,10 @@ Instead of simply capitalizing each word `titlecase` does the following
This tool makes use of prior work by [John Gruber][style], [Aristotle
Pagaltzis], and [David Gouch].

[Daring Fireball]: https://daringfireball.net/
[style]: https://daringfireball.net/2008/05/title_case
[Aristotle Pagaltzis]: http://plasmasturm.org/code/titlecase/
[crate-docs]: https://docs.rs/titlecase
[Daring Fireball]: https://daringfireball.net/
[David Gouch]: http://individed.com/code/to-title-case/
[MIT]: https://github.com/wezm/titlecase/blob/master/LICENSE
[crate-docs]: https://docs.rs/titlecase
[rustup]: https://www.rust-lang.org/tools/install
[style]: https://daringfireball.net/2008/05/title_case

0 comments on commit efd406a

Please sign in to comment.