chore: prepare for v0.3.0 (#13)

* chore: prepare for v0.3.0

* grammar

CHANGELOG.md

@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.0] - 2025-01-20
+
+- [Remove the '$' requirement to start an anchor](https://github.com/solidiquis/grits/pull/10)
+- [Filtering capabilities](https://github.com/solidiquis/grits/pull/11)
+- [Conditionally applied attributes and text alignment](https://github.com/solidiquis/grits/pull/12)
+
+Checkout the [documentation](https://github.com/solidiquis/grits/blob/main/docs/help.md).
+
 ## [0.2.0] - 2025-01-12
 
 Adds ability to require specified captures to have at least one match in order for output to show for a given line:

Cargo.toml

@@ -5,7 +5,7 @@ description = """
 A line-text processor that applies regular expressions with named captures to input lines
 and transforms them using a template string. See the long help '--help' for further details and examples.
 """
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 readme = "README.md"
 license = "MIT"

README.md

@@ -4,7 +4,7 @@
 [![Crates.io](https://img.shields.io/crates/v/grits.svg)](https://crates.io/crates/grits)
 [![Crates.io](https://img.shields.io/crates/d/grits)](https://crates.io/crates/grits)
 
-A simple line-text formatter that makes it simple to parse, filter, and format live logs, turning noise into meaningful insights.
+A simple line-text formatter that makes it simple to parse, filter, and format live logs turning noise into meaningful insights.
 
 ![demo gif](images/log.gif)
 
@@ -13,6 +13,12 @@ A simple line-text formatter that makes it simple to parse, filter, and format l
 </p>
 
 
+* [Installation](#installation)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [Donating](#donating)
+* [FAQ](#faq)
+
 At its core, `grits` applies regular expressions with named captures to input lines. These captures are then available as variables
 (a.k.a. anchors) which can then be used in a `grits` template string. The template string supports text-alignment, colorization,
 as well as other attributes you'd expect using ANSI escape sequences.
@@ -33,6 +39,30 @@ tcpdump -nn | grits -- \
   <em>The top pane in the above screenshot is the raw output of tcpdump while the bottom pane shows the output being piped into grits.</em>
 </p>
 
+## Installation
+
+### crates.io
+
+```bash
+cargo install grits
+```
+
+### cURL
+
+```bash
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/solidiquis/grits/releases/download/v0.3.0/grits-installer.sh | sh
+```
+
+### Powershell
+
+```bash
+powershell -ExecutionPolicy Bypass -c "irm https://github.com/solidiquis/grits/releases/download/v0.3.0/grits-installer.ps1 | iex"
+```
+
+### Manual installation
+
+Check the [releases page](https://github.com/solidiquis/grits/releases) for prebuilt binaries.
+
 
 ## Documentation
 
@@ -48,5 +78,9 @@ If you like this tool, please consider [buying me a coffee](https://buymeacoffee
 
 ## FAQ
 
-Q: **Why is this called grits?**
-A: I was really craving shrimp & grits while writing this on a plane going to South Korea.
+- Q: **Have you heard of lnav? Why should I use grits over lnav?**
+- A: I have heard of [lnav](https://github.com/tstack/lnav) but I haven't used it. Users are encouraged to use both to see what best fits their needs.
+
+- Q: **Why is this called grits?**
+- A: I was really craving shrimp & grits while writing this on a plane going to South Korea. Also, checkout my Spotify playlist called [Melancholy with a side of Grits](https://open.spotify.com/playlist/2bsBVlDXS1yWwUjxuSRtd2?si=44122d2dc11b4a90).
+

docs/help.md

@@ -1,7 +1,6 @@
 # Grits Documentation
 
 * [Usage](#usage)
-* [Installation](#installation)
 * [Templating language](#templating-language)
     - [Indexing](#indexing)
     - [Default values](#default-values)
@@ -36,32 +35,6 @@ Options:
   -V, --version                      Print version
 ```
 
-See the long `--help` description for further details and example from the command-line.
-
-## Installation
-
-### crates.io
-
-```bash
-cargo install grits
-```
-
-### cURL
-
-```bash
-curl --proto '=https' --tlsv1.2 -LsSf https://github.com/solidiquis/grits/releases/download/v0.2.0/grits-installer.sh | sh
-```
-
-### Powershell
-
-```bash
-powershell -ExecutionPolicy Bypass -c "irm https://github.com/solidiquis/grits/releases/download/v0.2.0/grits-installer.ps1 | iex"
-```
-
-### Manual installation
-
-Check the [releases page](https://github.com/solidiquis/grits/releases) for prebuilt binaries.
-
 ## Templating language
 
 `grits` uses a simple templating language to transform text. Templates consist of anchors.