Merge pull request #1 from adeven/readme_syntax_highlighting
Use fenced code blocks to enabled golang syntax highlighting in README.md
This commit is contained in:
		
							
								
								
									
										14
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,14 +1,18 @@ | |||||||
| Package uniuri | Package uniuri | ||||||
| ===================== | ===================== | ||||||
|  |  | ||||||
|  | ```go | ||||||
| import "github.com/dchest/uniuri" | 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: | ||||||
|  |  | ||||||
|  | ```go | ||||||
| s := uniuri.New() // s is now "apHCJBl7L1OmC57n" | 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,6 +27,7 @@ read from it. | |||||||
| Constants | Constants | ||||||
| --------- | --------- | ||||||
|  |  | ||||||
|  | ```go | ||||||
| const ( | 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 | ||||||
| @@ -30,13 +35,16 @@ Constants | |||||||
|     // 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 | ||||||
| --------- | --------- | ||||||
|  |  | ||||||
|  | ```go | ||||||
| var StdChars = []byte("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") | 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 | ||||||
|  |  | ||||||
|  | ```go | ||||||
| func New() string | 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 | ||||||
|  |  | ||||||
|  | ```go | ||||||
| func NewLen(length int) string | 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 | ||||||
|  |  | ||||||
|  | ```go | ||||||
| func NewLenChars(length int, chars []byte) string | 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). | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 Dmitry Chestnykh
					Dmitry Chestnykh