Skip to content

Commit 01f24e2

Browse files
DerekBumoleg-jukovec
authored andcommitted
docs: create a README file
In thes commit `README.md` and `CHANGELOG.md` files are created. `README` shows the purpose of this repository.
1 parent 74a8a0a commit 01f24e2

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic
7+
Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
8+
9+
## [Unreleased]
10+
11+
### Added
12+
13+
### Changed
14+
15+
### Removed
16+
17+
### Fixed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[![Go Reference][godoc-badge]][godoc-url]
2+
[![Code Coverage][coverage-badge]][coverage-url]
3+
4+
# tlsdialer
5+
6+
This package allows creating a TLS dialer for
7+
[`go-tarantool`](https://github.com/tarantool/go-tarantool).
8+
It serves as an interlayer between go-tarantool and go-openssl.
9+
10+
go-tlsdialer uses tarantool connection, but also types and methods from
11+
go-openssl.
12+
13+
## Run tests
14+
15+
To run a default set of tests:
16+
17+
```go
18+
go test -v ./...
19+
```
20+
21+
[godoc-badge]: https://pkg.go.dev/badge/github.com/tarantool/go-tlsdialer.svg
22+
[godoc-url]: https://pkg.go.dev/github.com/tarantool/go-tlsdialer
23+
[coverage-badge]: https://coveralls.io/repos/github/tarantool/go-tlsdialer/badge.svg?branch=master
24+
[coverage-url]: https://coveralls.io/github/tarantool/go-tlsdialer?branch=master

0 commit comments

Comments
 (0)