Skip to content

Commit adeeb39

Browse files
committed
chore: update readme
1 parent f13143c commit adeeb39

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
# ru-doc-codes
2+
[![GoDoc](https://godoc.org/github.com/mrfoe7/ru-doc-code?status.svg)](https://godoc.org/github.com/mrfoe7/ru-doc-code) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mrfoe7/ru-doc-code/blob/master/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/mrfoe7/ru-doc-code)](https://goreportcard.com/report/github.com/mrfoe7/ru-doc-code)
23

3-
It is validator about official codes of documents from Russia
4+
It is validator about official codes of documents from Russia in Go
45

56
## Usage
67

8+
* go get github.com/mrfoe7/ru-doc-codes
9+
10+
### Example
11+
712
```go
813

14+
isValid, err := ru-doc-code.IsSNILSValid("112-233-445 95")
15+
if err != nil {
16+
log.Fatal(err)
17+
}
18+
if isValid {
19+
log.Println("SNILS is valid")
20+
}
21+
922
```
1023

1124
## Documentation

0 commit comments

Comments
 (0)