Update changelog and README for theme.toml changes

bensadeh · Oct 13, 2024 · 16b4265 · 16b4265
1 parent bdad61c
commit 16b4265
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,16 +1,14 @@
 # Changelog
-## 4.1.0
-
-
 
+## 4.1.0
 
 ## 4.0.0
 
 ### Overview
 
 This release contains several new feature and breaking changes. From a user perspective, the most notable change is the
 addition of a `JSON` highlighter. From a developer's perspective, the highlighting engine powering `tailspin` has been
-decoupled and extracted into a separate library called `[manifold](https://github.com/bensadeh/manifold)`.
+decoupled and extracted into a separate library called [`manifold`](https://github.com/bensadeh/manifold).
 
 `manifold` will still be used internally by `tailspin`, but it will also be available as a standalone library for other
 projects to use.
@@ -23,6 +21,8 @@ projects to use.
 
 ### Breaking changes:
 
+- `tailspin` will now look for `theme.toml` instead of `config.toml` for the configuration file
+- Enabling and disabling highlight groups is now done from the command line instead of in the toml file
 - Removed the `border` from the style from the keyword styling. Instead, the border will be enabled implicitly by
   setting a background color for the keyword.
 - Removed date highlighting for formats like `Aug 14` and `Sun Dec 14` etc. (Can be re-enabled by adding a custom

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
   <img src="assets/tailspin.png" width="230"/>
 </p>
 
-#                                                                                                                                                                                                                                                                                                                     
+#                                                                                                                                                                                                                                                                                                                         
 
 <p align="center">
 A log file highlighter
@@ -199,8 +199,8 @@ Styles have the following shape:
 style = { fg = "color", bg = "color", italic = false, bold = false, underline = false }
 ```
 
-To edit the different highlight groups, include them in your `config.toml` file. For example, to edit the `date`
-highlight group, add the following to your `config.toml`:
+To edit the different highlight groups, include them in your `theme.toml` file. For example, to edit the `date`
+highlight group, add the following to your `theme.toml`:
 
 ```toml
 [date]
@@ -226,7 +226,6 @@ style = { fg = "red", italic = true }
 [[keywords]]
 words = ['GET']
 style = { fg = "black", bg = "green" }
-border = true
 
 [url]
 http = { fg = "red", faint = true }
@@ -277,14 +276,17 @@ id = { fg = "yellow" }
 
 ### Disabling Highlight Groups
 
-To disable a highlight group, set the `disabled` field for that group to true:
+To individually disable or enable highlight groups, use the `--enable` and `--disable` flags:
 
-```toml
-[date]
-disabled = true
+```console
+# Enable only the url highlight group, disabling the rest
+tspin application.log --enable=url
+
+# Disable the numbers highlight group, keeping the rest
+tspin application.log --disable=numbers
 ```
 
-### Adding Keywords via config.toml
+### Adding Keywords via theme.toml
 
 To add custom keywords, either include them in the list of keywords or add new entries: