git.iko.soy/jrec
on master help sign in
Update README.md
704e007Artyom Kazak
README.md+22−2
compare with master
unifiedsplit
@@ -1,2 +1,22 @@
1−# rec
1+# rec — anonymous records for busy people
2−Anonymous records!
2+
3+Based on [superrecord](https://hackage.haskell.org/package/superrecord), but simplified. No automatic field reordering. No GHCJS bits inside. Easier to hack on.
4+
5+O(1) field access.
6+
7+Nice construction syntax:
8+
9+```haskell
10+Rec (#id := 18853, #orderId := "MG13-233")
11+```
12+
13+Provides `Generic` instances out of the box. Aeson, etc can't believe these aren't normal records! Anything `Generic`-derived works out of the box.
14+
15+Provides `generic-lens` instances out of the box. Due to those custom instances, we support polymorphic updates.
16+
17+## TODOs
18+
19+* Documentation.
20+* Expose all internals.
21+* `-- NOTE: doesn't use 'KeyDoesNotExist'` — fix this.
22+* `RemoveAccessTo` — can we get rid of it?