Add more READMEs

This commit is contained in:
Joris Vink 2014-08-03 21:44:14 +02:00
parent 203fdc139d
commit 850e39fcfb
5 changed files with 43 additions and 5 deletions

View File

@ -74,8 +74,8 @@ Example libraries
You can find example libraries under **_examples/_**.
The examples should be compiled using the supplied **build.sh** scripts
and assume you have installed the header files using make install.
The examples contain a README file with instructions on how
to build or use them.
I apologize for unclear examples or documentation, I am working on
improving those.

View File

@ -0,0 +1,11 @@
Generic Kore application that shows off a few things:
* File uploads (/upload)
* Authentication blocks (/private)
* base64 encoding tests (/b64test)
* Parameter validator tests (/params-test)
Run:
```
# kore run
```

9
examples/pgsql/README.md Normal file
View File

@ -0,0 +1,9 @@
Kore pgsql example.
* Performs 2 async pgsql queries.
* You must set the connection string before running
Run:
```
# kore run
```

View File

@ -1,3 +0,0 @@
Compile this example using:
# env KORE_LDFLAGS="-I/path/to/libcurl -lcurl"

21
examples/tasks/README.md Normal file
View File

@ -0,0 +1,21 @@
Kore task example.
This example creates an asynchronous task from the page handler
that performs a POST to the same server and fetches its data
before returning to the client.
Build:
```
# env KORE_LDFLAGS="-I/path/to/libcurl -lcurl" kore build
```
Run:
```
# kore run
```
Test:
```
# curl -i -k https://127.0.0.1:8888/?id=astring
The returned data must match what you supplied in user ([a-z] string)
```