yolk/README.md

57 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2021-06-10 14:29:56 +08:00
<!--
* @Date: 2021-03-21 19:54:57
* @LastEditors: viletyy
* @LastEditTime: 2021-06-10 14:29:28
* @FilePath: /yolk/README.md
-->
# Yolk
[![viletyy yolk](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/viletyy/yolk)
Go项目公共包
在开发项目中,经常使用的方法。
本公共包包含以下内容:
1. 数据类型转换。
2. 常用加解密算法。
3. 文件夹辅助方法。
4. 分页。
5. 随机字符串。
## 内容列表
- [Yolk](#yolk)
- [内容列表](#内容列表)
- [安装](#安装)
- [使用说明](#使用说明)
- [如何贡献](#如何贡献)
- [使用许可](#使用许可)
## 安装
这个项目使用 [go](https://golang.org/) 。请确保你本地安装了它。
```sh
$ tar -C /usr/local -xzf go1.4.linux-amd64.tar.gz
$ export PATH=$PATH:/usr/local/go/bin
```
## 使用说明
```sh
$ go get -u github.com/viletyy/yolk
$ go mod tidy
$ go mod vendor
```
## 如何贡献
非常欢迎你的加入![提一个 Issue](https://github.com/viletyy/yolk/issues/new) 或者提交一个 Pull Request。
## 使用许可
[MIT](LICENSE) © Viletyy