git ssb - Update README with api info · Josiah/ssb-tags@26cb584b

Josiah Witt committed on 1/19/2018, 3:04:49 AM
Parent: 61c923460be3b91b9c4cf9d9b52ae59befefd4a9

changed

README.mdView
		@@ -1,7 +1,30 @@
1	1 …	# sbot-tags
2	2 …
3	3 …	[scuttlebot](http://scuttlebutt.nz/) plugin for indexing reduced "tags" state.
4	4 …
	5 …	+## API
	6 …	+
	7 …	+### `sbot.tags.get((err, data) => ...)`
	8 …	+
	9 …	+`data` is an object of form
	10 …	+
	11 …	+```js
	12 …	+{
	13 …	+ // a user id
	14 …	+ '@DOIjef...': {
	15 …	+ // a tag id
	16 …	+ '%cJEMdje...': {
	17 …	+ // a msg id
	18 …	+ '%x423jsadxj...': 1204594095 // timestamp tag was created
	19 …	+ }
	20 …	+ }
	21 …	+}
	22 …	+```
	23 …	+
	24 …	+### `sbot.tags.stream() => pull-stream`
	25 …	+
	26 …	+See [flumeview-reduce docs](https://github.com/flumedb/flumeview-reduce#dbnamestreamlive-boolean--pullsource).
	27 …	+
5	28 …	## License
6	29 …
7	30 …	MIT

Josiah / ssb-tags