aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcolin <colin@cicadas.surf>2024-08-30 19:54:28 -0700
committercolin <colin@cicadas.surf>2024-08-30 19:54:28 -0700
commit8dfe761225626375bea17611e8577656c40235cf (patch)
tree89a58da726a94c4fafdd749d556cad592e90f2e9
parentcaace2be47773b22faa03a39336517f73b5c97d0 (diff)
Add some text to README
-rw-r--r--README.org11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.org b/README.org
index efd1ad6..0e35df8 100644
--- a/README.org
+++ b/README.org
@@ -1,5 +1,14 @@
* `petty-types`
+A tiny library that provides
+
+- `type-specifier-p` a predicate that checks whether its argument is a
+ valid type specifier
+- `(list-of type &optional len)` DEFTYPE for a LIST of elements with TYPE
+- `(vector-of type &optional len)` DEFTYPE for a VECTOR of elements with TYPE
+
+ Here are some examples:
+
#+begin_src lisp
> (typep (list 1 2 3 4) '(list-of real))
@@ -35,6 +44,4 @@ NIL
> (typep "abab" '(vector-of (member #\a #\b) 4))
T
-
-
#+end_src