Skip to content

Commit 8b5625a

Browse files
committed
Minor improvements to documentation.
1 parent b6a4f9c commit 8b5625a

File tree

2 files changed

+35
-2
lines changed

2 files changed

+35
-2
lines changed

gems/webrick-rack-v3.rb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@
88
gem "rack", "~> 3.0.1"
99
gem "webrick"
1010
gem "rackup"
11-

readme.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Rack has pretty decent support for validating applications do the right thing us
2222

2323
## Usage
2424

25-
This repository includes test suite execution for published versions of major web servers. You can also run it for a specific server:
25+
This repository includes test suite execution for published versions of major web servers. You can also run it for a specific server.
26+
27+
### Falcon
2628

2729
``` bash
2830
export BUNDLE_GEMFILE=gems/falcon-v0-rack-v3.rb
@@ -32,6 +34,38 @@ export RACK_CONFORM_ENDPOINT="http://localhost:9292"
3234
bundle exec sus # run tests
3335
```
3436

37+
To see more details about the tests being run, use `sus --verbose`.
38+
39+
Falcon can also run tests over `https` using a self-signed certificate and this will cause HTTP/2 to be used.
40+
41+
``` bash
42+
export BUNDLE_GEMFILE=gems/falcon-v0-rack-v3.rb
43+
bundle install
44+
export RACK_CONFORM_SERVER="falcon --bind https://localhost:9292"
45+
export RACK_CONFORM_ENDPOINT="https://localhost:9292"
46+
bundle exec sus # run tests
47+
```
48+
49+
### Puma
50+
51+
``` bash
52+
export BUNDLE_GEMFILE=gems/puma-v6-rack-v3.rb
53+
bundle install
54+
export RACK_CONFORM_SERVER="puma --bind tcp://localhost:9292"
55+
export RACK_CONFORM_ENDPOINT="http://localhost:9292"
56+
bundle exec sus # run tests
57+
```
58+
59+
### Webrick
60+
61+
``` bash
62+
export BUNDLE_GEMFILE="gems/webrick-rack-v3.rb"
63+
bundle install
64+
export RACK_CONFORM_SERVER="rackup -s webrick"
65+
export RACK_CONFORM_ENDPOINT="http://localhost:9292"
66+
bundle exec sus
67+
```
68+
3569
### Starting A Server
3670

3771
You can also start a server running the conform application for independent testing (e.g. using `curl`).

0 commit comments

Comments
 (0)