Skip to content

Commit 4555dac

Browse files
committed
Update README.md to clarify stream color options and add direction parameter
1 parent 3023481 commit 4555dac

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,17 @@ Here are some examples of how to use the different configuration options:
8383
The different configuration options available in this project are:
8484

8585
* `mode`: The character symbol set to use. Valid options include "Original", "Binary", "Decimal", "Math", "ASCII", "Braille", "Emoji", and custom sets like "abc123".
86-
* `stream_color`: The color of the streaming entities, specified as an RGB value (e.g., "0,255,70").
86+
* `stream_color`: The color of the streaming entities (e.g., `"0,255,70"`, `"#00FF00"`, or `"green"`).
8787
* `stream_color_gradient_factor`: The multiplier that describes the extent of the gradient in the stream color.
88-
* `leading_entity_color`: The color of the leading entity in a stream, specified as an RGB value (e.g., "200,255,200").
88+
* `leading_entity_color`: The color of the leading entity in a stream (e.g., `"200,255,200"`, `"#C8FFC8"`, or `"white"`).
8989
* `leave_trail`: A boolean option to leave the trail intact as the streams pass by.
9090
* `fps`: The frame rate to run at, specified as the number of frames per second.
91+
* `direction`: The direction of motion for the stream particles (e.g., `"down"`, `"up"`, `"left"`, `"right"`, `"diagonal-right"`, etc.).
9192
* `stream_min_count`: The minimum number of entities per stream.
9293
* `stream_max_count`: The maximum number of entities per stream.
9394
* `stream_spacing`: The spacing between the streams, specified as the number of columns between each stream.
9495
* `switch_interval`: The maximum number of seconds within which an entity randomly switches its symbol.
9596

96-
These options are defined in the `src/config.rs` file.
97-
9897
### Modes
9998

10099
The different modes available for the `mode` option are:
@@ -108,8 +107,6 @@ The different modes available for the `mode` option are:
108107
* "Emoji" | "Cursed": Emojis
109108
* Custom sets like "abc123": User-defined symbol set
110109

111-
These modes are defined in the `src/config.rs` file.
112-
113110
### Customizing the Symbol Set
114111

115112
To specify custom character sets for the `mode` option, you can use the `Custom` variant of the `Symbols` enum.

0 commit comments

Comments
 (0)