Skip to content

Commit 07db6a2

Browse files
committed
[enh] adding and extending intro
1 parent d3c67e5 commit 07db6a2

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

‎README.rst

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ NGINX JavaScript examples
88
Intro
99
=====
1010

11-
Note: the examples below work with njs >= `0.5.2 <http://nginx.org/en/docs/njs/changes.html#njs0.5.2>`_.
11+
This repo contains complete examples for various use cases where `njs <http://nginx.org/en/docs/njs/>`_ is useful. The document as well as `njs documentation <http://nginx.org/en/docs/njs/>`_ expects some familiarity with and understanding of nginx. Beginners should refer to the official `admin guide <https://docs.nginx.com/nginx/admin-guide/>`_.
1212

13-
Running inside Docker:
13+
Note: the examples below work with njs >= `0.5.2 <http://nginx.org/en/docs/njs/changes.html#njs0.5.2>`_. To see the current version run the following command: ``docker run -i -t nginx:latest /usr/bin/njs -V``.
14+
15+
Running inside Docker
16+
---------------------
1417

1518
.. code-block:: shell
1619
@@ -22,8 +25,31 @@ Running inside Docker:
2225
# Stopping.
2326
docker stop njs_example
2427
25-
Hello world [http/hello]
26-
------------------------
28+
Status
29+
------
30+
While njs is in active development it is production ready. Its reliability has been proven by extensive test coverage as well as a good track record with our customers.
31+
32+
nginx compatibility
33+
-------------------
34+
As njs is a `native nginx module <http://nginx.org/en/docs/dev/development_guide.html#Modules>`_ its compatibility with nginx is high. While it is developed as a separate project, it is routinely tested with latest nginx versions on various platforms and architectures.
35+
36+
Presentation at nginx.conf 2018
37+
-------------------------------
38+
https://youtu.be/Jc_L6UffFOs
39+
40+
Installation
41+
------------
42+
njs is available as a part of official nginx docker image as well as an officially supported `packet <http://nginx.org/en/linux_packages.html>`_ for major linux distributions.
43+
44+
Repository
45+
----------
46+
Please ask questions, report issues, and send patches via official `Github mirror <https://github.com/nginx/njs>`_.
47+
48+
HTTP
49+
====
50+
51+
Hello world example [http/hello]
52+
--------------------------------
2753

2854
nginx.conf:
2955

@@ -72,9 +98,6 @@ Checking:
7298
curl http://localhost/version
7399
0.4.1
74100
75-
HTTP
76-
====
77-
78101
Authorization
79102
-------------
80103

0 commit comments

Comments
 (0)