diff --git a/.github/workflows/test.yml b/.github/workflows/ci.yml similarity index 99% rename from .github/workflows/test.yml rename to .github/workflows/ci.yml index a0c02e2..8819d7b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: Test +name: CI on: push: diff --git a/README.md b/README.md index 57efcc3..2f3a4b3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +[![GitHub tag](https://img.shields.io/github/v/tag/xsh-lib/shadowsocks?sort=date)](https://github.com/xsh-lib/shadowsocks/tags) +[![GitHub](https://img.shields.io/github/license/xsh-lib/shadowsocks.svg?style=flat-square)](https://github.com/xsh-lib/shadowsocks/) +[![GitHub last commit](https://img.shields.io/github/last-commit/xsh-lib/shadowsocks.svg?style=flat-square)](https://github.com/xsh-lib/shadowsocks/commits/main) + +[![CI](https://github.com/xsh-lib/shadowsocks/actions/workflows/ci.yml/badge.svg)](https://github.com/xsh-lib/shadowsocks/actions/workflows/ci.yml) +[![CodeFactor](https://www.codefactor.io/repository/github/xsh-lib/shadowsocks/badge)](https://www.codefactor.io/repository/github/xsh-lib/shadowsocks) +[![GitHub issues](https://img.shields.io/github/issues/xsh-lib/shadowsocks.svg?style=flat-square)](https://github.com/xsh-lib/shadowsocks/issues) +[![GitHub pull requests](https://img.shields.io/github/issues-pr/xsh-lib/shadowsocks.svg?style=flat-square)](https://github.com/xsh-lib/shadowsocks/pulls) + # xsh-lib/shadowsocks xsh Library - Shadowsocks toolkit. @@ -6,15 +15,18 @@ About xsh and its libraries, check out [xsh document](https://github.com/alexzha ## Requirements -1. bash or zsh +`xsh-lib/shadowsocks` is tested in CI ([GitHub Actions](https://github.com/xsh-lib/shadowsocks/actions/workflows/ci.yml)) on every push and pull request, across the following shell/OS combinations: - Tested with bash: - * 4.3.48 on Linux - * 3.2.57 on macOS +| Shell | Version | OS | Tested | +|-------|---------|-----------------------|:------:| +| bash | 3.2 | macOS | ✅ | +| bash | 4.4 | Linux (rockylinux:8) | ✅ | +| bash | 5.x | Linux (ubuntu-latest) | ✅ | +| bash | 5.x | macOS (Homebrew) | ✅ | +| zsh | 5.x | Linux (ubuntu-latest) | ✅ | +| zsh | 5.x | macOS | ✅ | - The utilities also run under **zsh** (the default shell on modern macOS); - xsh executes them under zsh's ksh emulation. Tested with zsh 5.x. - Requires xsh >= 0.7.0 for zsh. +zsh utilities run under xsh's ksh emulation and require **xsh ≥ 0.7.0**. ## Dependency