Use fenced code blocks to enabled golang syntax highlighting in README.md

This commit is contained in:
Christian Wellenbrock 2013-09-23 18:32:11 +02:00
parent 586d18d326
commit 3c1e943e8d

View File

@ -1,14 +1,18 @@
Package uniuri Package uniuri
===================== =====================
import "github.com/dchest/uniuri" ```go
import "github.com/dchest/uniuri"
```
Package uniuri generates random strings good for use in URIs to identify Package uniuri generates random strings good for use in URIs to identify
unique objects. unique objects.
Example usage: Example usage:
s := uniuri.New() // s is now "apHCJBl7L1OmC57n" ```go
s := uniuri.New() // s is now "apHCJBl7L1OmC57n"
```
A standard string created by New() is 16 bytes in length and consists of A standard string created by New() is 16 bytes in length and consists of
Latin upper and lowercase letters, and numbers (from the set of 62 allowed Latin upper and lowercase letters, and numbers (from the set of 62 allowed
@ -23,20 +27,24 @@ read from it.
Constants Constants
--------- ---------
const ( ```go
const (
// Standard length of uniuri string to achive ~95 bits of entropy. // Standard length of uniuri string to achive ~95 bits of entropy.
StdLen = 16 StdLen = 16
// Length of uniurl string to achive ~119 bits of entropy, closest // Length of uniurl string to achive ~119 bits of entropy, closest
// to what can be losslessly converted to UUIDv4 (122 bits). // to what can be losslessly converted to UUIDv4 (122 bits).
UUIDLen = 20 UUIDLen = 20
) )
```
Variables Variables
--------- ---------
var StdChars = []byte("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") ```go
var StdChars = []byte("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789")
```
Standard characters allowed in uniuri string. Standard characters allowed in uniuri string.
@ -46,21 +54,27 @@ Functions
### func New ### func New
func New() string ```go
func New() string
```
New returns a new random string of the standard length, consisting of New returns a new random string of the standard length, consisting of
standard characters. standard characters.
### func NewLen ### func NewLen
func NewLen(length int) string ```go
func NewLen(length int) string
```
NewLen returns a new random string of the provided length, consisting of NewLen returns a new random string of the provided length, consisting of
standard characters. standard characters.
### func NewLenChars ### func NewLenChars
func NewLenChars(length int, chars []byte) string ```go
func NewLenChars(length int, chars []byte) string
```
NewLenChars returns a new random string of the provided length, consisting NewLenChars returns a new random string of the provided length, consisting
of the provided byte slice of allowed characters (maximum 256). of the provided byte slice of allowed characters (maximum 256).