|
1 |
| -# Landscape apps |
| 1 | +# Tlon Messenger (TM) |
2 | 2 |
|
3 |
| -## Groups |
| 3 | +Tlon Messenger is a new kind of messenger which you can fully control. The user ID is your cryptographic property, while all your data is stored in a single file, yours to keep and yours to take. With TM, you own a distinct node on the network, which you can use to host a community, a blog, or run any other computation. This repository contains the source code of the two main components of TM: |
4 | 4 |
|
5 |
| -Start, host, and cultivate communities. Own your communications, organize your |
6 |
| -resources, and share documents. Groups is a decentralized platform that |
7 |
| -integrates with Talk, Notebook, and Gallery for a full, communal suite of tools. |
| 5 | +- TM client, which is available on iOS, Android and Desktop |
| 6 | +- TM backend, which is deployed on the Urbit platform |
8 | 7 |
|
9 |
| -## Talk |
| 8 | +## Client |
10 | 9 |
|
11 |
| -Send encrypted direct messages to one or many friends. Talk is a simple chat |
12 |
| -tool for catching up, getting work done, and everything in between. |
| 10 | +The client is written in React Native. The mobile version is available on iOS and Android, while the desktop version is available via browser (with a desktop app planned soon for macOS, Linux, and Windows). |
13 | 11 |
|
14 |
| -## Notebook |
| 12 | +## Backend |
15 | 13 |
|
16 |
| -Notebook is a standard short and long form text editor. Within Groups, you can |
17 |
| -use Notebook to write, edit, and publish text. |
| 14 | +The TM backend consists of a number of independent components, called agents. |
18 | 15 |
|
19 |
| -## Gallery |
| 16 | +### %groups |
20 | 17 |
|
21 |
| -Gallery is a versatile repository for collective knowledge and references you |
22 |
| -want to share or remember. Within Groups, you can use Gallery to collect links, |
23 |
| -images, media, and even random musings. |
| 18 | +%groups allows creation of communities that aggregate distinct communication channels. Each group sets its own rules by defining user roles and the entry policy, and defines a set of channels available for group members to subscribe to. |
24 | 19 |
|
25 |
| ---- |
| 20 | +### %channels |
26 | 21 |
|
27 |
| -## Developer documentation |
| 22 | +%channels facilitates communication between any number of parties by designating one node as the host. A channel can function as a group chat, a gallery or a notebook. Channels can be further customized with hooks, which allow you to program custom behaviours triggered by various channel events. |
28 | 23 |
|
29 |
| -This project uses the [formal comment spec](https://developers.urbit.org/reference/hoon/style#comments-and-unparsed-bytes) |
30 |
| -for all Hoon code to ensure compatibility with |
31 |
| -[doccords](https://github.com/urbit/urbit/pull/5873). |
| 24 | +### %chat |
32 | 25 |
|
33 |
| -Additionally, detailed documentation is available in the [Docs Landscape |
34 |
| -app](https://urbit.org/applications/~pocwet/docs) if you have both Docs and |
35 |
| -Groups installed on a running Urbit ship. |
| 26 | +%chat is a direct-message agent, which, unlike %channels, establishes peer-to-peer connection between two parties. |
36 | 27 |
|
37 |
| -Visit this repository's wiki for [an overview of how to use Landscape and |
38 |
| -its apps](https://github.com/tloncorp/tlon-apps/wiki). |
| 28 | +### %contacts |
| 29 | +%contacts manages the user profile ands track connections to other users, constructing the user's social graph as they interact with others on the network. |
39 | 30 |
|
40 |
| -## Integrating with Groups agents |
| 31 | +### %activity |
41 | 32 |
|
42 |
| -The `%groups` desk provides several simple agents with discrete concerns. This list may expand over time. |
| 33 | +%activity is TM's activity tracker. It aggregates events sent by other agents and alerts the user based on his notification settings. |
43 | 34 |
|
44 |
| -- `%groups` - The organizational substrate for constructing, joining, finding, |
45 |
| - and managing groups (different than the in-group activity of chatting, |
46 |
| - writing, or collecting) |
47 |
| -- `%groups-ui` - Optimized scries for the Groups UI |
48 |
| -- `%chat` - 1:1 and multi-DM capabilities for Talk and Chat channels in Groups |
49 |
| -- `%diary` - Notebook channels in Groups |
50 |
| -- `%heap` - Gallery channels in Groups |
51 |
| -- `%notify` - Hooks for iOS push notifications |
52 |
| -- `%grouper` - Handler for Lure invitiations |
| 35 | +### %profile |
53 | 36 |
|
54 |
| -All actions are performed with |
55 |
| -[pokes](https://developers.urbit.org/reference/glossary/poke). |
56 |
| -See the on-ship developer documentation for more details. |
| 37 | +%profile allows the user to expose a personal webpage accessible through their node's URL. The webpage can feature a preview of user's favorite groups or widgets registered by any other agents. |
57 | 38 |
|
58 |
| -## Use of Landscape agents |
| 39 | +### %expose |
59 | 40 |
|
60 |
| -At the moment, Groups and Talk make use of `%settings`, `%storage`, `%hark`, |
61 |
| -and `%contacts` agents in the `%landscape` desk. |
| 41 | +%expose allows the user to publish the content available in one of the channels to the clearweb. |
0 commit comments