Skip to content

Commit e5cb12c

Browse files
committed
📄 Update README.md
1 parent 185f50e commit e5cb12c

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# 🌐 `shadowsocks-uri-generator`
1+
# 🌐 Shadowsocks URI Generator
22

33
[![Build](https://github.com/database64128/shadowsocks-uri-generator/workflows/Build/badge.svg)](https://github.com/database64128/shadowsocks-uri-generator/actions?query=workflow%3ABuild)
44
[![Release](https://github.com/database64128/shadowsocks-uri-generator/workflows/Release/badge.svg)](https://github.com/database64128/shadowsocks-uri-generator/actions?query=workflow%3ARelease)
5+
56
<a href="https://aur.archlinux.org/packages/ss-uri-gen-git/">
6-
<img alt="AUR badge for ss-uri-gen-git" src="https://img.shields.io/aur/version/ss-uri-gen-git?label=AUR%20git" />
7+
<img alt="AUR badge for ss-uri-gen-git" src="https://img.shields.io/aur/version/ss-uri-gen-git?label=AUR%20ss-uri-gen-git" />
78
</a>
89
<a href="https://aur.archlinux.org/packages/ss-uri-gen-chatbot-telegram-git/">
9-
<img alt="AUR badge for ss-uri-gen-chatbot-telegram-git" src="https://img.shields.io/aur/version/ss-uri-gen-chatbot-telegram-git?label=AUR%20git" />
10+
<img alt="AUR badge for ss-uri-gen-chatbot-telegram-git" src="https://img.shields.io/aur/version/ss-uri-gen-chatbot-telegram-git?label=AUR%20ss-uri-gen-chatbot-telegram-git" />
11+
</a>
12+
<a href="https://aur.archlinux.org/packages/ss-uri-gen-rescue-git/">
13+
<img alt="AUR badge for ss-uri-gen-rescue-git" src="https://img.shields.io/aur/version/ss-uri-gen-rescue-git?label=AUR%20ss-uri-gen-rescue-git" />
1014
</a>
1115

1216
A light-weight command line automation tool for managing federated Shadowsocks servers. Automate deployments of [Outline servers](https://github.com/Jigsaw-Code/outline-server). Deliver configurations to users with [SIP008](https://github.com/shadowsocks/shadowsocks-org/issues/89).
@@ -16,11 +20,11 @@ A light-weight command line automation tool for managing federated Shadowsocks s
1620
- Manage users, nodes, and groups with intuitive commands.
1721
- Deploy and manage [Outline servers](https://github.com/Jigsaw-Code/outline-server).
1822
- Retrieve user credentials automatically from Outline servers, or add credentials manually in plaintext or `base64url`.
19-
- Gather user data usage statistics from Outline servers.
20-
- Export user's associated nodes as [SIP002](https://shadowsocks.org/en/spec/SIP002-URI-Scheme.html) `ss://` URLs.
21-
- Support [SIP003](https://shadowsocks.org/en/spec/Plugin.html) plugins.
22-
- Generate SIP008-compliant online configuration files.
23-
- Generate and print SIP008 delivery URL.
23+
- Gather data usage statistics from Outline servers.
24+
- Manage data usage limit on users and groups. Enforce data limit on Outline servers.
25+
- Generate [SIP002](https://shadowsocks.org/en/spec/SIP002-URI-Scheme.html) `ss://` URLs for users.
26+
- Support for [SIP003](https://shadowsocks.org/en/spec/Plugin.html) plugins.
27+
- Generate SIP008 online config files and delivery URLs.
2428
- Run as a service to execute scheduled tasks.
2529
- Easy user interactions via [Telegram bots](https://core.telegram.org/bots).
2630

@@ -115,16 +119,16 @@ $ ss-uri-gen group get-data-usage MyGroupA
115119
$ ss-uri-gen online-config generate
116120

117121
# Print all users' SIP008 delivery URLs.
118-
$ ss-uri-gen online-config get-link
122+
$ ss-uri-gen online-config get-links
119123

120124
# Associate a group with an Outline server.
121125
$ ss-uri-gen outline-server add MyGroupA '{"apiUrl":"https://localhost/example","certSha256":"EXAMPLE"}'
122126

123127
# Change Outline server settings.
124128
$ ss-uri-gen outline-server set MyGroupA --name MyOutlineA --hostname github.com --metrics true
125129

126-
# Update Outline server information.
127-
$ ss-uri-gen outline-server update MyGroupA
130+
# Pull updates from Outline server.
131+
$ ss-uri-gen outline-server pull MyGroupA
128132

129133
# Deploy local configuration to Outline server.
130134
$ ss-uri-gen outline-server deploy MyGroupA
@@ -140,14 +144,18 @@ $ ss-uri-gen-chatbot-telegram config set --bot-token "1234567:4TT8bAc8GHUspu3ERY
140144

141145
# Telegram bot: run as a service.
142146
$ ss-uri-gen-chatbot-telegram
147+
148+
# Rescue tool: rebuild database from generated online config.
149+
$ ss-uri-gen-rescue --online-config-dir /path/to/online/config
143150
```
144151

145152
## License
146153

147154
- This project is licensed under [GPLv3](LICENSE).
148155
- The icons are from [Material Design Icons](https://materialdesignicons.com/) and are licensed under the [Pictogrammers Free License](https://dev.materialdesignicons.com/license).
149156
- [`System.CommandLine`](https://github.com/dotnet/command-line-api) is licensed under the MIT license.
150-
- [`JsonSnakeCaseNamingPolicy`](https://github.com/dotnet/corefx/pull/40003) is licensed under the MIT license.
157+
- `System.Linq.Async` and `System.Interactive.Async` are from [dotnet/reactive](https://github.com/dotnet/reactive). They are licensed under the MIT license.
158+
- `JsonSnakeCaseNamingPolicy` is adopted from [dotnet/corefx#40003](https://github.com/dotnet/corefx/pull/40003). It's licensed under the MIT license.
151159
- [`Telegram.Bot`](https://github.com/TelegramBots/Telegram.Bot) and [`Telegram.Bot.Extensions.Polling`](https://github.com/TelegramBots/Telegram.Bot.Extensions.Polling) are licensed under the MIT license.
152160

153161
© 2021 database64128

0 commit comments

Comments
 (0)