thunderstrike/purescript-httpurple
thunderstrike/purescript-httpurple
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix unclear docs

Browse Source
This commit is contained in:
Connor Prussin 2018-02-24 18:49:45 -08:00
parent f943420351
commit b6ec731120
No known key found for this signature in database
GPG Key ID: C72452E036D53A6A
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/Basics.md
View File

@ -22,18 +22,21 @@ guide](./Middleware.md).
You can create an HTTPure server without SSL using `HTTPure.serve`:
```purescript
main :: forall e. HTTPure.ServerM (console :: Console.CONSOLE | e)
main = HTTPure.serve 8080 router $ Console.log "Server up"
```
You can also create a server using a custom `HTTP.ListenOptions` `Record`:
```purescript
main = HTTPure.serve' customOptions router $ Console.log "Server up"
```
Most of the [examples](./Examples), besides [the SSL Example](./Examples/SSL),
use this method to create the server.
You can also create a server using a custom
`[HTTP.ListenOptions](http://bit.ly/2G42rLd)` value:
```purescript
main :: forall e. HTTPure.ServerM (console :: Console.CONSOLE | e)
main = HTTPure.serve' customOptions router $ Console.log "Server up"
```
## SSL
You can create an SSL-enabled HTTPure server using `HTTPure.serveSecure`, which
@ -41,19 +44,21 @@ has the same signature as `HTTPure.serve` except that it additionally takes a
path to a cert file and a path to a key file after the port number:
```purescript
main :: forall e. HTTPure.SecureServerM (console :: Console.CONSOLE | e)
main =
HTTPure.serveSecure 8080 "./Certificate.cer" "./Key.key" router $
Console.log "Server up"
```
You can also create a server using a `HTTP.ListenOptions` and a `Options
HTTPS.SSLOptions`:
You can look at [the SSL Example](./Examples/SSL/Main.purs), which uses this
method to create the server.
You can also create a server using a
`[HTTP.ListenOptions](http://bit.ly/2G42rLd)` and a `Options
[HTTPS.SSLOptions](http://bit.ly/2G3Aljr)`:
```purescript
main :: forall e. HTTPure.SecureServerM (console :: Console.CONSOLE | e)
main =
HTTPure.serveSecure' customSSLOptions customOptions router $
Console.log "Server up"
```
You can look at [the SSL Example](./Examples/SSL/Main.purs), which uses this
method to create the server.