Skip to content

Commit ad9d089

Browse files
luccasterastesla
authored andcommitted
fixes to README file
Signed-off-by: Samuel Tesla <samuel.tesla@gmail.com>
1 parent 2892e32 commit ad9d089

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.markdown

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ make
1313
sudo make install
1414
</pre>
1515

16-
This will install natter at: _/usr/local/lib/erlang/lib/_
16+
This will install natter at: __/usr/local/lib/erlang/lib/__
1717

1818
## If you are using Ubuntu and installed erlang via apt-get:
1919

2020
<pre>
2121
autoreconf --install
22-
./configure --prefix=/usr
22+
./configure --prefix=/usr/
2323
make
2424
sudo make install
2525
</pre>
2626

27-
This will install natter at: _/usr/lib/erlang/lib/_
27+
This will install natter at: __/usr/lib/erlang/lib/__
2828

2929
# Getting Started
3030

@@ -60,8 +60,11 @@ natter_connection:register_exchange(Cn, "iq", "bar@localhost", self()).
6060
# Internals
6161

6262
3 main modules:
63+
6364
* __natter_connection__: public API. Runs as a supervisor.
65+
6466
* __natter_packetizer__: responsible for dealing with all network traffic. Reads in incoming XML and finds out when you have a complete packet. It then sends the packet to the dispatcher.
67+
6568
* __natter_dispatcher__: figures out where packets should go.
6669

6770
XML Parsing is done using an erlang wrapper around libexpat. Inspired by Jabberlang. Faster than xmerl.
@@ -73,10 +76,14 @@ XML is parsed into a tuple:
7376

7477
# TODO
7578

76-
-Move away from plain-text authentication
77-
-Support for presence
78-
-Support for message stanzas
79-
-Support for rosters
79+
* Move away from plain-text authentication
80+
81+
* Support for presence
82+
83+
* Support for message stanzas
84+
85+
* Support for rosters
86+
8087

8188
# Resources/Links
8289

0 commit comments

Comments
 (0)