Skip to content

Commit 5ed4525

Browse files
authored
changes based on Codacy recommendations
1 parent 714ce0d commit 5ed4525

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,12 @@ kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u usern
7979

8080
There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party utilities (e.g. stunnel, [socat](https://linux.die.net/man/1/socat), ghosttunnel, etc).
8181

82-
### Example using `socat`
82+
* Example using `socat`. Remember to replace items enclosed with `<>`.
8383

84-
Remember to replace items enclosed with `<>`.
85-
86-
```shell
87-
socat tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:6697
88-
kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname'
89-
```
84+
```shell
85+
socat tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:6697
86+
kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname'
87+
```
9088

9189
## SASL PLAIN Authentication
9290

@@ -108,25 +106,23 @@ $ kirc -n jilles -a amlsbGVzAGppbGxlcwBzZXNhbWU=
108106

109107
Similar to `SASL PLAIN`, the `SASL EXTERNAL` mechanism allows us to authenticate using credentials by external means. An example where this might be required is when trying to connect to an IRC host through [Tor](https://www.torproject.org/). To do so, we can using third-party utilities (e.g. stunnel, [socat](https://linux.die.net/man/1/socat), ghosttunnel, etc).
110108

111-
### Example using `socat`
112-
113-
Remember to replace items enclosed with `<>`.
109+
* Example using `socat`. Remember to replace items enclosed with `<>`.
114110

115-
```shell
116-
socat TCP4-LISTEN:1110,fork,bind=0,reuseaddr SOCKS4A:127.0.0.1:<onion_address.onion>:<onion_port>,socksport=9050
117-
socat TCP4-LISTEN:1111,fork,bind=0,reuseaddr 'OPENSSL:127.0.0.1:1110,verify=0,cert=<path_to_pem>'
118-
kirc -e -s 127.0.0.1 -p 1111 -n <nick> -x 'wait 5000'
119-
```
111+
```shell
112+
socat TCP4-LISTEN:1110,fork,bind=0,reuseaddr SOCKS4A:127.0.0.1:<onion_address.onion>:<onion_port>,socksport=9050
113+
socat TCP4-LISTEN:1111,fork,bind=0,reuseaddr 'OPENSSL:127.0.0.1:1110,verify=0,cert=<path_to_pem>'
114+
kirc -e -s 127.0.0.1 -p 1111 -n <nick> -x 'wait 5000'
115+
```
120116

121117
## Color Scheme Definition
122118

123119
Applying a new color scheme is easy! One of the quickest ways is to use an application, such as [kfc](https://github.com/mcpcpc/kfc), to apply pre-made color palettes. Alternatively, you can manually apply escape sequences to change the default terminal colors.
124120

125-
### Example using `kfc`
121+
* Example using `kfc`
126122

127-
```shell
128-
kfc -s gruvbox
129-
```
123+
```shell
124+
kfc -s gruvbox
125+
```
130126

131127
### Example using ANSI escape sequences
132128

@@ -155,7 +151,7 @@ printf -e "\033]4;<color_number>;#<hex_color_code>"
155151

156152
## FAQ
157153

158-
* __KISS__ is an acronym for [Keep It Simple Stupid](https://en.wikipedia.org/wiki/KISS_principle), which is a design principle noted by the U.S. Navy in 1960s. The KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.
154+
* **KISS** is an acronym for [Keep It Simple Stupid](https://en.wikipedia.org/wiki/KISS_principle), which is a design principle noted by the U.S. Navy in 1960s. The KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.
159155

160156
## Contact
161157

0 commit comments

Comments
 (0)