final release and deprecation

Author: ylxdzsw

.github/workflows/workflow.yml

@@ -14,8 +14,8 @@ jobs:
           - { name: x86_64-windows-msvc, os: windows-latest, target: x86_64-pc-windows-msvc }
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: stable
           target: ${{ matrix.target }}
@@ -27,7 +27,7 @@ jobs:
         if: matrix.name != 'x86_64-windows-msvc'
       - run: mv target/${{ matrix.target }}/release/v2socks.exe target/${{ matrix.target }}/release/v2socks
         if: matrix.name == 'x86_64-windows-msvc'
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: v2socks-${{ matrix.name }}
           path: target/${{ matrix.target }}/release/v2socks
@@ -37,8 +37,8 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/v')
     needs: [test]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/download-artifact@v2
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
       - run: |
           mkdir artifacts
           mv v2socks-x86_64-linux-gnu/v2socks artifacts/v2socks-x86_64-linux-gnu

readme.md

@@ -1,4 +1,23 @@
 V2socks
 =======
 
-An opinionated lightweight socks5 server and vmess (v2ray) client implemented in Rust.
+An opinionated lightweight socks5 server and vmess (v2ray) client implemented in Rust.
+
+#### Deprecation
+
+This software is no longer maintained. (It still works as of Sept. 2024)
+
+You might be interested in another of my project [sopipe](https://github.com/ylxdzsw/sopipe), which also implements the
+functionalities in this project, plus much more!
+
+Example of running a socks5 server and a vmess client using `sopipe`:
+
+```sh
+$ sopipe 'tcp(1080) => socks5_server => vmess_client("49aa7c07-2cd4-4585-b645-3392fde45b90") => tcp("example.com:3399")'
+```
+
+or through HTTP2 over TLS:
+
+```sh
+$ sopipe 'tcp(1080) => socks5_server => vmess_client("49aa7c07-2cd4-4585-b645-3392fde45b90") => http2_client("example.com", "/")'
+```