doc: vweb README (#10106)

vlib/vweb/README.md

@@ -1,20 +1,26 @@
-This is pre-alpha software.
+# vweb - the V Web Server #
 
-## Features
-- Very fast: performance of C on the web.
-- Small binary: hello world website is <100 KB.
-- Easy to deploy: just one binary file that also includes all templates.
+A simple yet powerful web server with built-in routing, parameter handling,
+templating, and other features.
+
+## Alpha level software ##
+
+Some features may not be complete, and there may still be bugs.  However, it is
+still a very useful tool.  The [gitly](https://gitly.org/) site is based on vweb.
+
+## Features ##
+
+- **Very fast** performance of C on the web.
+- **Small binary** hello world website is <100 KB.
+- **Easy to deploy** just one binary file that also includes all templates.
   No need to install any dependencies.
-- Templates are precompiled, all errors are visible at compilation time,
+- **Templates are precompiled** all errors are visible at compilation time,
   not at runtime.
 
-Lots of things are broken and not implemented yet in V and vweb.
+There is no formal documentation yet - here is a simple
+[example](https://github.com/vlang/v/tree/master/examples/vweb/vweb_example.v)
 
-There's no documentation yet, have a look at a simple example:
-
-https://github.com/vlang/v/tree/master/examples/vweb/vweb_example.v
-
-There's also the V forum: https://github.com/vlang/vorum
+There's also the V forum, [vorum](https://github.com/vlang/vorum)
 
 `vorum.v` contains all GET and POST actions.
 
@@ -36,7 +42,6 @@ pub fn (app App) post() {
 	show_form := true
 	$vweb.html()
 }
-
 ```
 
 `index.html` is an example of the V template language:
@@ -53,23 +58,24 @@ pub fn (app App) post() {
 ```
 
 `$vweb.html()` compiles an HTML template into V during compilation,
-and embeds the resulting code in current action.
+and embeds the resulting code into the current action.
 
 That means that the template automatically has access to that action's entire environment.
 
-
-### Deploying vweb apps
+## Deploying vweb apps ##
 
 Everything, including HTML templates, is in one binary file. That's all you need to deploy.
 
-## Getting Started
+## Getting Started ##
 
-To start with vweb, you have to import the module `vweb`.
-After the import, define a struct to hold vweb.Context
-(and any other variables your program will need).
-The web server can be started by calling `vweb.run<App>(port)`.
+To start with vweb, you have to import the module `vweb`.  After the import,
+define a struct to hold vweb.Context (and any other variables your program will
+need).
+
+The web server can be started by calling `vweb.run<App>(&App{}, port)`.
 
 **Example:**
+
 ```v ignore
 import vweb
 
@@ -78,16 +84,18 @@ struct App {
 }
 
 fn main() {
-	vweb.run<App>(8080)
+	vweb.run<App>(&App{}, 8080)
 }
 ```
 
-### Defining endpoints
+### Defining endpoints ###
+
 To add endpoints to your web server, you have to extend the `App` struct.
 For routing you can either use auto-mapping of function names or specify the path as an attribute.
 The function expects a response of the type `vweb.Result`.
 
 **Example:**
+
 ```v ignore
 // This endpoint can be accessed via http://localhost:port/hello
 fn (mut app App) hello() vweb.Result {
@@ -104,6 +112,7 @@ fn (mut app App) world() vweb.Result {
 To create an HTTP POST endpoint, you simply add a `[post]` attribute before the function definition.
 
 **Example:**
+
 ```v ignore
 [post]
 fn (mut app App) world() vweb.Result {
@@ -116,6 +125,7 @@ an attribute, e. g. `['/hello/:user]`.
 After it is defined in the attribute, you have to add it as a function parameter.
 
 **Example:**
+
 ```v ignore
 ['/hello/:user']
 fn (mut app App) hello_user(user string) vweb.Result {
@@ -126,6 +136,6 @@ fn (mut app App) hello_user(user string) vweb.Result {
 You have access to the raw request data such as headers
 or the request body by accessing `app` (which is `vweb.Context`).
 If you want to read the request body, you can do that by calling `app.req.data`.
-To read the request headers, you just call `app.req.header` and access the header you want,
-e.g. `app.req.header.get(.content_type)`. See `struct Header` for all
-available methods (`v doc net.http Header`).
+To read the request headers, you just call `app.req.header` and access the
+header you want, e.g. `app.req.header.get(.content_type)`. See `struct Header`
+for all available methods (`v doc net.http Header`).