Browse Source

Update docs.

Dmitry Chestnykh 13 years ago
parent
commit
b80c582b33
2 changed files with 4 additions and 10 deletions
  1. 3 9
      README.md
  2. 1 1
      captcha.go

+ 3 - 9
README.md

@@ -43,7 +43,7 @@ verify that the given solution is the right one for the given captcha id.
 Server provides an http.Handler which can serve image and audio
 Server provides an http.Handler which can serve image and audio
 representations of captchas automatically from the URL. It can also be used
 representations of captchas automatically from the URL. It can also be used
 to reload captchas.  Refer to Server function documentation for details, or
 to reload captchas.  Refer to Server function documentation for details, or
-take a look at the example in "example" subdirectory.
+take a look at the example in "capexample" subdirectory.
 
 
 
 
 Examples
 Examples
@@ -211,6 +211,8 @@ NewImage returns a new audio captcha with the given digits, where each digit
 must be in range 0-9. Digits are pronounced in the given language. If there
 must be in range 0-9. Digits are pronounced in the given language. If there
 are no sounds for the given language, English is used.
 are no sounds for the given language, English is used.
 
 
+Possible values for lang are "en", "ru", "zh".
+
 ### func (*Audio) EncodedLen
 ### func (*Audio) EncodedLen
 
 
 	func (a *Audio) EncodedLen() int
 	func (a *Audio) EncodedLen() int
@@ -279,11 +281,3 @@ Bugs
 * While Image conforms to io.WriterTo interface, its WriteTo
 * While Image conforms to io.WriterTo interface, its WriteTo
 method returns 0 instead of the actual bytes written because png.Encode
 method returns 0 instead of the actual bytes written because png.Encode
 doesn't report this.
 doesn't report this.
-
-
-Subdirectories
---------------
-
-* capgen
-* example
-* generate

+ 1 - 1
captcha.go

@@ -42,7 +42,7 @@
 // Server provides an http.Handler which can serve image and audio
 // Server provides an http.Handler which can serve image and audio
 // representations of captchas automatically from the URL. It can also be used
 // representations of captchas automatically from the URL. It can also be used
 // to reload captchas.  Refer to Server function documentation for details, or
 // to reload captchas.  Refer to Server function documentation for details, or
-// take a look at the example in "example" subdirectory.
+// take a look at the example in "capexample" subdirectory.
 package captcha
 package captcha
 
 
 import (
 import (