Skip to content

Commit 4272131

Browse files
authored
Update README.md
1 parent be5b064 commit 4272131

File tree

1 file changed

+19
-38
lines changed

1 file changed

+19
-38
lines changed

README.md

+19-38
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,41 @@
1-
# TM Tlon Messenger
1+
# Tlon Messenger (TM)
22

3-
Tlon Messenger is a new kind of messenger which you can fully control.
4-
User ID is your cryptographic property, while all your data is stored in a single
5-
file, yours to keep and yours to take. With TM, you own a distinct node on the
6-
network, which you can use to host a community, a blog, or run any other computation.
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:
74

8-
This repository contains the source code of the two main components of TM:
9-
- TM app, which is available on iOS, Android and Desktop.
5+
- TM client, which is available on iOS, Android and Desktop
106
- TM backend, which is deployed on the Urbit platform
117

12-
## TM App
8+
## Client
139

14-
TM App is written in React Native. The mobile version is available on iOS and Android,
15-
while desktop app is available on Linux, Mac and Windows.
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).
1611

17-
## TM Backend
12+
## Backend
1813

19-
TM backend consists of a number of independent components, called
20-
_agents_.
14+
The TM backend consists of a number of independent components, called agents.
2115

2216
### %groups
23-
%groups allow creation of communities that aggregate distinct
24-
communication channels. Each group sets its own rules by defining user
25-
roles and the entry policy, and defines a set of channels available for
26-
groups members to subscribe to.
17+
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.
2719

2820
### %channels
29-
%channels facilitate communication between any number of parties by
30-
designating one node as the host. A channel can function as a group chat,
31-
a gallery or a notebook. Channels can be further customized with TM Hooks, which
32-
allow you to program custom behaviours triggered by various channel
33-
events.
21+
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.
3423

3524
### %chat
36-
%chat is a direct-message agent, which, unlike %channels, establishes peer-to-peer connection
37-
between two parties.
25+
26+
%chat is a direct-message agent, which, unlike %channels, establishes peer-to-peer connection between two parties.
3827

3928
### %contacts
40-
%contacts manage the user profile, and track connections to other
41-
users, constructing the user's social graph as he interacts with others
42-
on the TM network.
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.
4330

4431
### %activity
45-
%activity is TM's activity tracker. It aggregates events sent
46-
by other agents and alerts the user based on his notification settings.
47-
48-
### %profile
49-
%profile allows the user to expose a personal webpage accessible through
50-
his node's URL. The webpage can feature a preview of user's groups, or a
51-
widget registered by any other agent.
5232

53-
### %expose
54-
%expose allows the user to publish the content available in one of the
55-
channels to the clearweb.
33+
%activity is TM's activity tracker. It aggregates events sent by other agents and alerts the user based on his notification settings.
5634

57-
---
35+
### %profile
5836

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.
5938

39+
### %expose
6040

41+
%expose allows the user to publish the content available in one of the channels to the clearweb.

0 commit comments

Comments
 (0)