Commit af259461a794b832781b7a8e8f03c39087dc5237
update docs
Dominic Tarr committed on 5/12/2016, 9:42:00 AMParent: 0131ecbd3cc024a9049c5dab91ce05c70613dcd5
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -8,20 +8,26 @@ | ||
| 8 | 8 | |
| 9 | 9 | This makes in very easy to create say, a renderer for a new message type, |
| 10 | 10 | or switch to a different method for choosing user names. |
| 11 | 11 | |
| 12 | -Currently, this is a proof of concept and only renders the 100 most recent | |
| 13 | -messages. This should obviously be replaced with a module that can | |
| 14 | -scroll properly through a feed, which should plug into another module | |
| 15 | -that gives tabs or something like that. | |
| 12 | +Currently, this is a proof of concept, there is a basic way to switch | |
| 13 | +between tabs, and you can view the main log, user feeds, or threads. | |
| 14 | +This should obviously be improved with a module that can | |
| 15 | +scroll properly scoll through a feed. | |
| 16 | 16 | |
| 17 | +No "write" methods have been implemented yet. | |
| 17 | 18 | |
| 18 | 19 | ## overview |
| 19 | 20 | |
| 20 | -Currently, the main module is `message.js` which plugs into | |
| 21 | -the `message_render` socket, and provides `message_content`, `avatar`, | |
| 22 | -`message_meta` and `message_action` hooks. | |
| 21 | +Currently, the main module is `tabs.js` which plugs into | |
| 22 | +the `app` socket, and provides the `screen_view` socket. | |
| 23 | +when you click a link, `screen_view` socket with the link path, | |
| 24 | +which returns a html element which becomes a new tab. | |
| 23 | 25 | |
| 26 | +currently, `main.js` `feed.js` and `thread.js` plug into `screen_view` | |
| 27 | +and then in turn, call the `message_render` socket, which calls | |
| 28 | +`message_content` `avatar` `message_meta` `message_action` and `message_link`. | |
| 29 | + | |
| 24 | 30 | `avatar.js` plugs into `avatar`, and provides the `avatar_name` socket. |
| 25 | 31 | it just returns a link to the public key, labled with what it gets back |
| 26 | 32 | from `avatar_name` socket. this is in turn provided by the `names.js` module. |
| 27 | 33 | |
| @@ -73,4 +79,7 @@ | ||
| 73 | 79 | |
| 74 | 80 | ## License |
| 75 | 81 | |
| 76 | 82 | MIT |
| 83 | + | |
| 84 | + | |
| 85 | + | |
Built with git-ssb-web