Skip to content

Commit de80370

Browse files
committed
docs: enforce 80-column line widths in README
- Break long sentences across multiple lines at natural break points - Maintain readability while adhering to 80-column standard - Keep table content and URLs intact (acceptable exceptions) - Follow markdown best practices for line breaks
1 parent 55681cf commit de80370

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@
1212
![Monthly Downloads][monthly-downloads]
1313
<br>
1414

15-
[BusyLight for Humans][busylight-for-humans] controls USB LED lights from multiple vendors.
16-
Use the command-line interface or HTTP API to turn lights on/off, change colors, and apply effects.
17-
For Python integration, use [Busylight Core][busylight-core] directly in your applications.
15+
[BusyLight for Humans][busylight-for-humans] controls USB LED lights from
16+
multiple vendors. Use the command-line interface or HTTP API to turn lights
17+
on/off, change colors, and apply effects. For Python integration, use
18+
[Busylight Core][busylight-core] directly in your applications.
1819

1920
![All Supported Lights][DEMO]
2021
Flag<sup>1</sup>,
@@ -85,7 +86,8 @@ python3 -m pip install busylight-for-humans[webapi]
8586

8687
## Development Install
8788

88-
This project uses [uv][uv-docs] for dependency management, virtual environments, and packaging.
89+
This project uses [uv][uv-docs] for dependency management, virtual
90+
environments, and packaging.
8991

9092
```console
9193
$ python3 -m pip install uv
@@ -97,7 +99,8 @@ $ source .venv/bin/activate
9799
<venv> $ pytest
98100
```
99101

100-
The project installs in editable mode. Source changes are reflected immediately when running in the virtual environment.
102+
The project installs in editable mode. Source changes are reflected
103+
immediately when running in the virtual environment.
101104

102105
## Linux Post-Install Activities
103106

@@ -139,7 +142,8 @@ $ busylight off # turn off all LEDs (default)
139142

140143
## HTTP API Examples
141144

142-
First start the `busylight` API server using the `busyserv` command line interface:
145+
First start the `busylight` API server using the `busyserv` command line
146+
interface:
143147
```console
144148
$ busyserve -D
145149
INFO: Started server process [40064]
@@ -215,14 +219,16 @@ $ curl -s "http://localhost:8000/light/0/blink?color=blue&led=2&count=5" | jq
215219

216220
## LED Parameter Reference
217221

218-
For devices with multiple LEDs (like Blink1 mk2), use the `--led` option (CLI) or `led` parameter (API):
222+
For devices with multiple LEDs (like Blink1 mk2), use the `--led` option
223+
(CLI) or `led` parameter (API):
219224

220225
- `led=0`: Control all LEDs (default behavior)
221226
- `led=1`: Control first/top LED
222227
- `led=2`: Control second/bottom LED
223228
- `led=3+`: Control additional LEDs (BlinkStick variants)
224229

225-
Single-LED devices ignore the LED parameter. Device-specific LED indexing varies by manufacturer.
230+
Single-LED devices ignore the LED parameter. Device-specific LED indexing
231+
varies by manufacturer.
226232

227233
### Authentication
228234
The API can be secured with a simple username and password through
@@ -231,7 +237,9 @@ for all API requests, set the `BUSYLIGHT_API_USER` and
231237
`BUSYLIGHT_API_PASS` environmental variables before running
232238
`busyserve`.
233239

234-
> :warning: **SECURITY WARNING**: HTTP Basic Auth sends usernames and passwords in *cleartext* (i.e., unencrypted). Use of SSL is highly recommended!
240+
> :warning: **SECURITY WARNING**: HTTP Basic Auth sends usernames and
241+
> passwords in *cleartext* (i.e., unencrypted). Use of SSL is highly
242+
> recommended!
235243
236244
### Gratitude
237245

0 commit comments

Comments
 (0)