Browse code

add documentation for web API

Joseph Weston authored on 19/07/2018 16:31:45
Showing 3 changed files
... ...
@@ -7,3 +7,4 @@ API documentation
7 7
 
8 8
    reference/api.rst
9 9
    reference/vpn.rst
10
+   reference/web.rst
10 11
new file mode 100644
... ...
@@ -0,0 +1,3 @@
1
+``nord.web``
2
+------------
3
+.. automodule:: nord.web
... ...
@@ -16,12 +16,8 @@
16 16
 # along with this program.  if not, see <http://www.gnu.org/licenses/>.
17 17
 """Serve nord as a web app.
18 18
 
19
-To use this package as a library, simply instantiate an instance of the
20
-app with `init_app`.
21
-
22 19
 The API can be accessed by opening a websocket connection to '/api'.
23 20
 
24
-
25 21
 Requests
26 22
 ========
27 23
 The API accepts 2 types of request.