Skip to content

Commit a763760

Browse files
[STYLE] some style changes for consistancy (- WIP PR #419 -)
Changes in file README.md: * style changes
1 parent cea83d1 commit a763760

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ applications, making it straightforward to work with multicast sockets.
1010

1111
## Features
1212

13-
- **Easy Multicast Communication**: Send and receive messages over multicast networks with
13+
* **Easy Multicast Communication**: Send and receive messages over multicast networks with
1414
simple `Python` interfaces.
15-
- **Command-Line Tools**: Includes command-line utilities for quick multicast prototyping.
16-
- **Cross-Python Compatibility**: Designed to work with multiple Python versions.
17-
- **Support for UDP**: Works with UDP via IPv4 multicast addresses.
15+
* **Command-Line Tools**: Includes command-line utilities for quick multicast prototyping.
16+
* **Cross-Python Compatibility**: Designed to work with multiple Python versions.
17+
* **Support for UDP**: Works with UDP via IPv4 multicast addresses.
1818

1919
## Status
2020

@@ -178,19 +178,19 @@ listener(group='224.0.0.1', port=59259, ttl=1)
178178

179179
The `multicast` package provides command-line tools for multicast communication prototyping.
180180

181-
- Read the [Usage](docs/USAGE.md) for details.
181+
* Read the [Usage](docs/USAGE.md) for details.
182182

183183
## FAQ
184184

185-
- Read the [FAQ](docs/FAQ.md) for common answers.
185+
* Read the [FAQ](docs/FAQ.md) for common answers.
186186

187187
## Default Settings
188188

189-
- **Multicast Group Address**: `224.0.0.1` (link-local multicast as per
189+
* **Multicast Group Address**: `224.0.0.1` (link-local multicast as per
190190
[RFC 5771](https://tools.ietf.org/html/rfc5771))
191-
- **Default Port**: `59259` (within the dynamic/private port range defined by
191+
* **Default Port**: `59259` (within the dynamic/private port range defined by
192192
[RFC 6335](https://tools.ietf.org/html/rfc6335))
193-
- **Time-to-Live (TTL)**: `1` (as recommended by
193+
* **Time-to-Live (TTL)**: `1` (as recommended by
194194
[RFC 1112 Section 6.1](https://tools.ietf.org/html/rfc1112#section-6.1)
195195
; messages do not leave the local network)
196196

@@ -199,16 +199,16 @@ The `multicast` package provides command-line tools for multicast communication
199199
In the realm of network communication, security is paramount. When using multicast communication,
200200
be vigilant about potential vulnerabilities:
201201

202-
- **Data Sanitization**: Always sanitize incoming data to prevent injection attacks
202+
* **Data Sanitization**: Always sanitize incoming data to prevent injection attacks
203203
([CWE-20](https://cwe.mitre.org/data/definitions/20.html),
204204
[CWE-74](https://cwe.mitre.org/data/definitions/74.html)).
205205

206-
- **Network Scope**: Be mindful of the TTL settings to limit message propagation to the intended
206+
* **Network Scope**: Be mindful of the TTL settings to limit message propagation to the intended
207207
network segment. Inappropriate TTL values might expose your multicast traffic beyond the local
208208
network, potentially leading to information disclosure
209209
([CWE-200](https://cwe.mitre.org/data/definitions/200.html)).
210210

211-
- **Validation and Error Handling**: Implement robust validation and error handling to prevent
211+
* **Validation and Error Handling**: Implement robust validation and error handling to prevent
212212
misuse or disruption of multicast services.
213213
([CWE-351](https://cwe.mitre.org/data/definitions/351.html)).
214214

0 commit comments

Comments
 (0)