Changeset 149 in code for trunk/README.md

Timestamp:

Mar 21, 2024, 10:39:20 PM (15 months ago)

Author:

Izuru Yakumo

Message:

Ready for v0.2.3

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File:

• trunk/README.md (modified) (2 diffs)

trunk/README.md

@@ -20 +20 @@
 
 ## Installation and setup
-Requirement: Go version 1.16 or higher.
+Requirement: Go version 1.16 or higher (thus making it incompatible with MortyProxy's own requirement, but also to use `go embed`)
 
 ```
-$ go install marisa.chaotic.ninja/yukari@latest
+$ go install marisa.chaotic.ninja/yukari/cmd/yukari@latest
 $ "$GOPATH/bin/yukari" --help
 ```
 
 ### Usage
-
-```
-  -debug
-        Debug mode (default true)
-  -followredirect
-        Follow HTTP GET redirect
-  -hashparam string
-        User-defined requesting string HASH parameter name (ie: '/?hash=...' or '/?h=...') (default "yukarihash")
-  -ipv6
-        Allow IPv6 HTTP requests (default true)
-  -key string
-        HMAC url validation key (base64 encoded) - leave blank to disable validation
-  -listen string
-        Listen address (default "127.0.0.1:3000")
-  -proxy string
-        Use the specified HTTP proxy (ie: '[user:pass@]hostname:port'). Overrides -socks5, -ipv6.
-  -proxyenv
-        Use a HTTP proxy as set in the environment (HTTP_PROXY, HTTPS_PROXY and NO_PROXY). Overrides -proxy, -socks5, -ipv6.
-  -socks5 string
-        Use a SOCKS5 proxy (ie: 'hostname:port'). Overrides -ipv6.
-  -timeout uint
-        Request timeout (default 5)
-  -urlparam string
-        User-defined requesting string URL parameter name (ie: '/?url=...' or '/?u=...') (default "yukariurl")
-  -version
-        Show version
-```
+See `yukari(1)`
 
 ### Environment variables
@@ -82 +56 @@
 
 ## Bugs
-Bugs or suggestions? Visit the [issue tracker](https://git.chaotic.ninja/yakumo.izuru/yukari/issues).
+Bugs or suggestions? Mail [yukari-dev@chaotic.ninja](mailto:yukari-dev@chaotic.ninja)