git ssb - add readme for contact topic · dinoworm 🐛/patchcore@69c1dd03

mix irving committed on 9/17/2017, 11:02:49 PM
Parent: 143864a633b1e646bb0d20ace68ff0c977bacd43

README.md	changed
docs/contact.md	added

README.mdView
		@@ -9,9 +9,8 @@
9	9
10	10	- [ssb-private](https://github.com/ssbc/ssb-private)
11	11	- [ssb-backlinks](https://github.com/ssbc/ssb-backlinks)
12	12	- [ssb-about](https://github.com/ssbc/ssb-about)
13		-- [ssb-contacts](https://github.com/ssbc/ssb-contacts)
14	13
15	14	## apps
16	15
17	16	here's a list of apps in the wild using `patchcore`:
		@@ -44,16 +43,16 @@
44	43	- lib (junk that isn't part of any topic and should really be published as a reusable module, but too lazy)
45	44	- about
46	45	- blob
47	46	- config
48		-- contact
	47	+- [contact](./docs/contact.md)
49	48	- emoji
50	49	- feed
51	50	- invite
52	51	- keys
53	52	- message
	53	+- [router](./docs/router.md)
54	54	- sbot
55		-- [router](./docs/router.md)
56	55
57	56	### types
58	57
59	58	- sync

docs/contact.mdView
		@@ -1,0 +1,49 @@
	1	+# Contact
	2	+
	3	+## `contact.async.follow`
	4	+
	5	+`(id, cb)` - follow feed with key = `id`
	6	+
	7	+
	8	+## `contact.async.unfollow`
	9	+
	10	+`(id, cb)` - unfollow feed with key = `id`
	11	+
	12	+
	13	+## `contact.async.followerOf`
	14	+
	15	+...
	16	+
	17	+
	18	+## `contact.async.block`
	19	+
	20	+`(id, cb)` - block feed with key = `id`
	21	+
	22	+Note that blocking influences the observeable state of following, followers, blockers, blocking,
	23	+
	24	+
	25	+## `contact.async.unblock`
	26	+
	27	+`(id, cb)` - unblock feed with key = `id`
	28	+
	29	+
	30	+## `contact.obs.following`
	31	+
	32	+`(id)` returns an observeable which resolves to an array of feeds that `id` is following
	33	+
	34	+
	35	+## `contact.obs.followers`
	36	+
	37	+`(id)` returns an observeable which resolves to an array of feeds that follow `id`
	38	+
	39	+
	40	+## `contact.obs.blocking`
	41	+
	42	+`(id)` returns an observeable which resolves to an array of feeds that `id` is blocking
	43	+
	44	+
	45	+## `contact.obs.blockers`
	46	+
	47	+`(id)` returns an observeable which resolves to an array of feeds that block `id`
	48	+
	49	+

dinoworm 🐛 / patchcore