Documentation for furnace.auth.basic

2008-11-16 07:19:20 -06:00 · 2008-11-16 07:19:20 -06:00 · 1412778ff8
parent 7a26f30d85
commit 1412778ff8
1 changed files with 12 additions and 0 deletions
--- a/basis/furnace/auth/basic/basic-docs.factor
+++ b/basis/furnace/auth/basic/basic-docs.factor
@ -0,0 +1,12 @@
+USING: help.markup help.syntax ;
+IN: furnace.auth.basic
+
+HELP: <basic-auth-realm>
+{ $values { "responder" "a responder" } { "name" "an authentication realm name" } { "realm" basic-auth-realm } }
+{ $description "Wraps a responder in a basic authentication realm." } ;
+
+ARTICLE: "furnace.auth.basic" "Basic authentication"
+"The " { $vocab-link "furnace.auth.basic" } " vocabulary implements HTTP basic authentication."
+{ $subsection <basic-auth-realm> } ;
+
+ABOUT: "furnace.auth.basic"