ctbcap: optimize descriptions format

- README.md: optimize descriptions format - docker-compose.sample.yml: optimize format
KFERMercer · Jan 24, 2025 · 32babbd · 32babbd
1 parent 343c997
commit 32babbd
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 <div align="center"><p><strong><a href="#officel-ctbcap-container-registry">Officel Container Registry</a></strong></p></div>
 
-<div align="center"><h2>Key Advantages:</h2></div>
+<div align="center"><h2>Key Advantages</h2></div>
 
 - **Lightweight** - Written by most basic Shell Scripts with full POSIX compatibility. [Pythonless](https://m.media-amazon.com/images/I/71CmeuB3XXL._AC_UF1000,1000_QL80_.jpg), but far superior performance and energy efficiency.
 
@@ -14,7 +14,7 @@
 
 - **Multifunction** - Auto Recording; Auto Monitoring; Auto Stopping; Large-Scale Deploy... Just find by yourself.
 
-<div align="center"><h2>Usage | Deploy:</h2></div>
+<div align="center"><h2>Usage | Deploy</h2></div>
 
 ### **Launch with One-Command:**
 
@@ -40,8 +40,6 @@
 
 > If you're using such platforms that have good support for Docker or similar, I highly recommend to use this method: More serious; High-Availability; Everything runs in containers; Easily configures lot of chatrooms at the same time.
 
-> See [Container Arguments](#container-arguments).
-
 #### **Officel CtbCap Container Registry:**
 
   - [Docker Hub](https://hub.docker.com/r/kfermercer/ctbcap)\
@@ -50,18 +48,18 @@
   - [GitHub Package](https://github.com/KFERMercer/chaturbate-grabber/pkgs/container/ctbcap)\
     `docker pull ghcr.io/kfermercer/ctbcap:latest`
 
-  - | Platform | Available |
-    | :-: | :-: |
-    | x86 | ✅ |
-    | x86_64 | ✅ |
-    | armhf | ✅ |
-    | armv7 | ✅ |
-    | aarch64 | ✅ |
-    | loongarch64 | ✅ |
-    | ppc64le | ✅ |
-    | riscv64 | ✅ |
-    | s390x | ✅ |
-    - **CtbCap will always deliver on the [Compatibility Promise](https://news.berkeley.edu/wp-content/uploads/2017/10/SaguaroCardon750.jpg).**
+| Platform | Available |
+| :-: | :-: |
+| x86 | ✅ |
+| x86_64 | ✅ |
+| armhf | ✅ |
+| armv7 | ✅ |
+| aarch64 | ✅ |
+| loongarch64 | ✅ |
+| ppc64le | ✅ |
+| riscv64 | ✅ |
+| s390x | ✅ |
+> **CtbCap will always deliver on the [Compatibility Promise](https://news.berkeley.edu/wp-content/uploads/2017/10/SaguaroCardon750.jpg).**
 
 #### **Run As Compose Daemon (Recommend)** :
 

diff --git a/ctbcap b/ctbcap
@@ -60,7 +60,7 @@ doc() {
 		echo "              Simping Stream from CB & SC"
 	;;
 	help)
-		echo "Usage: ctbcap [options...] <username|url>"
+		echo "Usage: ctbcap [options...] <Username|URL>"
 		echo
 		echo "<username|url>		Streamer's Username or Chat"
 		echo "			Room URL."
@@ -84,7 +84,7 @@ doc() {
 		echo
 		echo "-f </path/to/recdir>	Recording [f]iles will save"
 		echo "			to this path."
-		echo "			Default: /\${PWD}/rec/"
+		echo "			Default: \${PWD}/rec/"
 		echo "			Don't Use if Runs in Docker."
 		echo
 		echo "-h			Get [H]elp for Commands."
@@ -283,7 +283,7 @@ utils() {
 			2>/dev/null | tr -d '\r'
 	;;
 	# Reuse results of connect_dump to get HTTP status code at the time.
-	# Usage: `utils dump2status "<URL dump>"`
+	# Usage: `utils dump2status "<URL DUMP>"`
 	dump2status)
 		echo "$2" \
 			| head -n 1 \
@@ -304,6 +304,7 @@ utils() {
 		done
 		echo $(( RSEED % ( BNUM - SNUM ) + SNUM )) # Format Same as $((RANDOM)) in Bash.
 	;;
+	# Usage: `utils check_depend "<COMMAND>"`
 	check_depend)
 		command -v "$2" 1>/dev/null 2>&1 || {
 			echo "(ERROR) Command [$2] not found! Check \$PATH or install it." >&2

diff --git a/docker-compose.sample.yml b/docker-compose.sample.yml
@@ -1,11 +1,10 @@
 services:
 
-  modelname_1: &template-config # Change modelname to yours.
+  modelname_1: &ctbcap-cfg # Change modelname to yours.
     image: kfermercer/ctbcap:latest # Mirror: ghcr.io/kfermercer/ctbcap:latest
-    container_name: ctbcap-modelname_1 # Change modelname to yours.
     user: 1000:1000 # <UID>:<GID>. Specify the user (UID) and group (GID) that the ctbcap will run as.
     restart: unless-stopped
-    environment: &template-environment
+    environment: &ctbcap-env
       MODEL: modelname_1 # Change modelname to yours.
       PLATFORM: chaturbate # What platform are model streaming at. choose "chaturbate" or "stripchat".
       TZ: Asia/Shanghai # Naming saved files & logs by using this timezone. See <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List>.
@@ -22,12 +21,11 @@ services:
 
   # Only need modifying values that different from template.
   modelname_2:
-    <<: *template-config
-    container_name: ctbcap-modelname_2
+    <<: *ctbcap-cfg
     # user: 1000:1000
     # restart: unless-stopped
     environment:
-      <<: *template-environment
+      <<: *ctbcap-env
       MODEL: modelname_2
       # PLATFORM: chaturbate
       # TZ: Asia/Shanghai
@@ -39,8 +37,7 @@ services:
     #   - /path/to/logdir:/log
 
   modelname_3:
-    <<: *template-config
-    container_name: ctbcap-modelname_3
+    <<: *ctbcap-cfg
     environment:
-      <<: *template-environment
+      <<: *ctbcap-env
       MODEL: modelname_3