From 8dfe761225626375bea17611e8577656c40235cf Mon Sep 17 00:00:00 2001
From: colin <colin@cicadas.surf>
Date: Fri, 30 Aug 2024 19:54:28 -0700
Subject: Add some text to README

---
 README.org | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'README.org')

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
-- 
cgit v1.2.3