Skip to content

docs: add tested-platforms matrix and badge header; standardize workflow to ci.yml #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexzhangs merged 2 commits into from
Jun 14, 2026
Merged

docs: add tested-platforms matrix and badge header; standardize workflow to ci.yml #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
def3146
docs: add tested-platforms matrix and badge header; standardize workf…
alexzhangs Jun 14, 2026
0fb5730
docs: add CodeFactor code-quality badge
alexzhangs Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yml → .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test
name: CI

on:
push:
Expand Down
26 changes: 19 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand Down
Loading