Browse code

core: several updates to the README

Daniel-Constantin Mierla authored on 10/06/2015 12:48:00
Showing 1 changed files
... ...
@@ -11,7 +11,8 @@ Table of contents
11 11
   III. Getting started
12 12
   IV.  About the project
13 13
   V.   Obtaining Help
14
-  VI.  More Information
14
+  VI.  Contributions
15
+  VII. More Information
15 16
 
16 17
 
17 18
 I. About Kamailio
... ...
@@ -20,32 +21,35 @@ I. About Kamailio
20 21
 Kamailio is an industrial-strength, free server for realtime communication,
21 22
 based on the Session Initiation Protocol (SIP RFC3261). 
22 23
 
23
-It is engineered to power Realtime Communications such as IP telephony and presence 
24
-infrastructures up to large scale. With embedded support for WebSockets, HTTP,
25
-MSRP and XMLrpc as well as Json-rpc it's a modern server, up to date with current
26
-standards.
24
+It is engineered to power Realtime Communications such as IP telephony and
25
+presence infrastructures up to large scale. With embedded support for
26
+WebSockets/WebRTC, HTTP, XSRP and XMLrpc as well as Json-rpc it's a modern
27
+server, up to date with current standards on IPv4/IPv6 and TLS security.
27 28
 
28 29
 Kamailio keeps track of users, sets up multimedia sessions, relays instant 
29
-messages and creates space for new plug-in applications. Its proven interoperability 
30
-guarantees seamless integration with components from other vendors, eliminating the 
31
-risk of a single-vendor trap. Kamailio has successfully participated in various 
32
-interoperability tests in which it worked with the products 
33
-of other leading SIP vendors.
34
-
35
-The Kamailio software enables a flexible plug-in model for new applications: Third parties 
36
-can easily link their plug-ins with the server code and provide thereby advanced and
37
-customized services. With a modern RPC interface, 3rd party application can integrate
38
-and interact with services provided by Kamailio. By using the EVAPI interface or the
39
-embedded HTTP server restful applications can be built.
40
-
41
-Kamailio's performance and robustness allows it to serve millions of users and accommodate needs
42
-of very large operators. With a low-cost dual-CPU, the Kamailio server is able to power 
43
-IP telephony services in an area as large as the Bay Area during peak hours.
44
-
45
-The Kamailio server is extremely configurable to allow the creation of various routing and 
46
-admission policies as well as setting up new and customized services. Its configurability 
47
-allows it to serve many roles: network security barrier, presence server, application server, 
48
-IMS server or PSTN gateway guard (Session Border Controller) for example.
30
+messages and creates space for new plug-in applications. Its proven
31
+interoperability guarantees seamless integration with components from other
32
+vendors, eliminating the risk of a single-vendor trap. Kamailio has
33
+successfully participated in various interoperability tests in which it worked
34
+with the products of other leading SIP vendors.
35
+
36
+The Kamailio software enables a flexible plug-in model for new applications:
37
+third parties can easily link their plug-ins with the server code and provide
38
+thereby advanced and customized services. With a modern RPC interface, 3rd
39
+party application can integrate and interact with services provided by
40
+Kamailio. By using the EVAPI interface or the embedded HTTP server restful
41
+applications can be built.
42
+
43
+Kamailio's performance and robustness allows it to serve millions of users and
44
+accommodate needs of very large operators. With a low-cost dual-CPU, the
45
+Kamailio server is able to power IP telephony services in an area as large as
46
+the Bay Area during peak hours.
47
+
48
+The Kamailio server is extremely configurable to allow the creation of various
49
+routing and admission policies as well as setting up new and customized
50
+services. Its configurability  allows it to serve many roles: network security
51
+barrier, presence server, application server,  IMS server or PSTN gateway guard
52
+(Edge Proxy / Session Border Controller) for example.
49 53
 
50 54
 
51 55
 II. Feature List
... ...
@@ -60,7 +64,13 @@ our web site for a current list.
60 64
 III. Getting started
61 65
 ====================
62 66
 
63
-The INSTALL document will guide you through the installation.
67
+The documentation wiki is an important source of tutorials for installing
68
+and understanding how Kamailio works:
69
+
70
+  * http://www.kamailio.org/wiki/
71
+
72
+The INSTALL document provides more details and guidelines that will help with
73
+the installation.
64 74
 
65 75
 Kamailio is composed of a core and additional modules. For each module
66 76
 there is a README with documentation on how to configure and use the 
... ...
@@ -74,15 +84,16 @@ IV. About kamailio.org
74 84
 ========================
75 85
 
76 86
 The Kamailio project has roots in a line of projects starting with SIP Express
77
-Router, then OpenSER and now Kamailio. A merge project was started during the fall
78
-of 2008 by developers from the OpenSER project, recently renamed to Kamailio.org
79
-and SIP Express Router (SER) from iptel.org. 
87
+Router, then OpenSER and now Kamailio. A merge project was started during the
88
+fall of 2008 by developers from the OpenSER project, recently renamed to
89
+Kamailio.org and SIP Express Router (SER) from iptel.org. 
80 90
 
81 91
 Kamailio is the result of a merge of the code base and years of experience from
82
-both developer teams. In release 4.0, during the spring of 2013, the
83
-merger of the products was completed and a unified product was released.
92
+both developer teams. During the development of the release 4.0, autumn-winter
93
+of 201w, the merger of the products was completed and a unified product was
94
+released.
84 95
 
85
-See http://www.kamailio.org/ for the story of SER, OpenSER/Kamailio and kamailio.org.
96
+See http://www.kamailio.org/ for the story of SER, OpenSER and Kamailio.
86 97
 
87 98
 V. Obtaining Help
88 99
 =================
... ...
@@ -97,8 +108,27 @@ list is set up for mutual help by the community of Kamailio users and developers
97 108
 To participate in the mailing list, subscribe at the following web address: 
98 109
          http://lists.sip-router.org/mailman/listinfo/sr-users
99 110
 
100
-VI. More Information
101
-====================
111
+The IRC channel #kamailio on freenode.net is a place where to meet and discuss
112
+with other members of Kamailio community.
113
+
114
+VI. Contributions
115
+=================
116
+
117
+Kamailio is an open source project managed and developed by its community.
118
+Anyone is welcome to join the development efforts and contribute with code,
119
+documentation or other resources that could help the project.
120
+
121
+For code contributions, follow the suggestions provided at:
122
+
123
+  * http://www.kamailio.org/wiki/devel/git-commit-guidelines
124
+
125
+The recommended way to contribute code is via pull requests to Kamailio
126
+project on Github:
127
+
128
+  * https://github.com/kamailio
129
+
130
+VII. More Information
131
+=====================
102 132
 
103 133
 Most up-to-date information is always available at our website,
104 134
                  http://www.kamailio.org/