summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBotahamec <botahamec@outlook.com>2023-07-30 20:14:20 -0400
committerBotahamec <botahamec@outlook.com>2023-07-30 20:14:20 -0400
commit647c16830edf49be28455f5cd7a189f38d75572a (patch)
treef4f5376a843613ef569654712814547967dae763
parentfb66891fbac0daed8e85f8c4e2fc598baa112d18 (diff)
Create README
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a63da26
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Snob
+
+This is a library that serves to make parsing strings a bit easier. I use this
+to easily write tokenizers. This was inspired by the Icon programming language,
+which in turn was inspired by SNOBOL. That's how this library came to be known
+as snob.
+
+## Usage
+
+The minimum supported Rust version for this library is 1.66.1.
+
+To use this in your crate, add the following to your `Cargo.toml`.
+
+```toml
+[dependencies]
+# ...
+snob = "0.1"
+```