From 81a6191276285b6f7ce0118688013f1a5af8533f Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Tue, 22 Oct 2024 16:57:09 +0100 Subject: [PATCH] updates readme --- spelling/README.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/spelling/README.md b/spelling/README.md index b8af97d..3d8a0bd 100644 --- a/spelling/README.md +++ b/spelling/README.md @@ -48,15 +48,13 @@ Vale is highly customizable and the boilerplate styles may not be what you need. Finally, there are more nuanced Consensys-specific styles such as substitutions, acronym overrides, and other configurations in the [Consensys Style folder](./styles/Consensys). -The [vale.ini](vale.ini) file provides various switches to turn styles on and off and to set what file types are formatted. Furthermore, as part of the GHA, the downstream repos that use this can specify which folders Vale may lint. - -## To do +The [vale.ini](.vale.ini) file provides various switches to turn styles on and off and to set what file types are formatted. Furthermore, as part of the GHA, the downstream repos that use this can specify which folders Vale may lint. ## Vale and YAML -Vale might need a parser to handle linting YAMLs (e.g., PyYAML, ruyaml). Then update the `.vale.ini` file to include the YAML style guide and specify the file extensions to lint. +Vale needs a parser to handle linting YAMLs. This is (possibly/probably) why there is an additional ini file [vale-star.ini](vale-star.ini). -### Incorporate `project-words.txt` from repos +### Incorporated `project-words.txt` from repos Bash NOT GPT @@ -82,19 +80,12 @@ Bash NOT GPT ## Test this -title should trigger ConsenSys should trigger Should trigger: With off brand Metamask - ′ - ″ -zk-EVM -goerli -Goerli -on-chain - + Shouldn't trigger booleans