irongit

A rust macro that allows regular expression creation through independent files. Allows fully typed named groups.

docs warn to avoid rust keywords

huncholanehuncholaneauthored
parent e687b10commit 6ac9f78e99a5d8084d826cde07fc2bb788546b87Browse files

3 files changed, +13 -3

+1-1Cargo.lock
@@ -78,7 +78,7 @@ checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
7878
7979 [[package]]
8080 name = "regex_folder_macro"
81-version = "1.0.0"
81+version = "1.0.1"
8282 dependencies = [
8383 "lazy_static",
8484 "proc-macro2",
+1-1Cargo.toml
@@ -5,7 +5,7 @@ repository = "https://github.com/huncholane/regex_folder_macro"
55 license = "MIT"
66 documentation = "https://docs.rs/regex_folder_macro"
77 homepage = "https://github.com/huncholane/regex_folder_macro"
8-version = "1.0.0"
8+version = "1.0.1"
99 edition = "2021"
1010
1111 [dependencies]
+11-1README.md
@@ -6,6 +6,10 @@ Allows for named groups in regular expressions to be generated from special file
66
77 ## Usage
88
9+### Warnings
10+
11+- Do not use rust syntax keywords such as type for field names in .re files
12+
913 ### Initialization
1014
1115 - Call the `load_regex_files!` macro on the directory that contains regex files.
@@ -37,9 +41,15 @@ The abstract structure for matches within the regex_folder_macro library contain
3741 - Files load automatically into precompiled struct with macros which allows rust-analyzer to use provide type hints.
3842 - Regular expressions can be split over multiple lines and use comments to improve readability for regular expressions.
3943
44+### Changes
45+
46+#### 1.0.1
47+
48+- Update the docs
49+
4050 ### Breaking changes
4151
42-#### 0.0.6 -> 1.0.0
52+#### 1.0.0
4353
4454 - Functions from files require a buffer
4555