Browse Source

update README

Kieran Gibb 1 year ago
parent
commit
386e1d125d
No known key found for this signature in database
1 changed files with 4 additions and 2 deletions
  1. 4
    2
      README.md

+ 4
- 2
README.md View File

@@ -1,6 +1,6 @@
1 1
 # cobox-group-store
2 2
 
3
-A store for loading into memory multiple `cobox-group``'s for iterating over and operating on...
3
+A repository for your cobox-groups. Adhere's to a standard CRUD repository pattern.
4 4
 
5 5
 ## API
6 6
 
@@ -11,5 +11,7 @@ const store = Store(storage)
11 11
 
12 12
 let groups = await store.all() // ensures groups loaded, then returns an array of cobox-groups
13 13
 
14
-let group = await store.get(id) // provide a name string, a 32 byte string, or a 64 byte string. ensures groups loaded, then retrieves group from store.
14
+await store.findBy({ name, address })
15
+await store.where({ name, address })
16
+await store.create({ name, address })
15 17
 ```