Skip to content

Commit d1b8d3f

Browse files
committed
docs: i dont like emojis in docs, just the roll dice
1 parent cde5e2e commit d1b8d3f

1 file changed

Lines changed: 38 additions & 38 deletions

File tree

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99

1010
TrueEntropy harvests chaos from the physical world to generate truly random numbers. Unlike pseudo-random number generators (PRNGs) that use deterministic algorithms, TrueEntropy collects entropy from:
1111

12-
- ⏱️ **CPU Timing Jitter** - Nanosecond variations in code execution
13-
- 🌐 **Network Latency** - The "weather" of internet infrastructure
14-
- 💻 **System State** - RAM, processes, and hardware fluctuations
15-
- 🌍 **External APIs** - Seismic activity (USGS), cryptocurrency prices
12+
- **CPU Timing Jitter** - Nanosecond variations in code execution
13+
- **Network Latency** - The "weather" of internet infrastructure
14+
- **System State** - RAM, processes, and hardware fluctuations
15+
- **External APIs** - Seismic activity (USGS), cryptocurrency prices
1616

1717
All entropy sources are mixed using SHA-256 cryptographic hashing, ensuring uniform distribution and unpredictability.
1818

@@ -118,37 +118,37 @@ Fetches real-world data:
118118
## How It Works
119119

120120
```
121-
┌─────────────────────────────────────────────────────────────┐
122-
ENTROPY HARVESTERS
123-
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────────┐
124-
│ │ Timing │ │ Network │ │ System │ │ External
125-
│ │ Jitter │ │ Latency │ │ State │ │ APIs
126-
│ └────┬─────┘ └────┬─────┘ └────┬─────┘ └──────┬───────┘
127-
128-
└────────────┴─────┬──────┴──────────────┘
129-
130-
┌─────────────┐
131-
MIXER SHA-256 Hashing
132-
(Whitening) Avalanche Effect
133-
└──────┬──────┘
134-
135-
┌───────────────────────┐
136-
ENTROPY POOL 4096 bits
137-
(Accumulated State) Thread-safe
138-
└───────────┬───────────┘
139-
140-
┌─────────────┐
141-
EXTRACTOR Secure extraction
142-
(Tap) Depletion protection
143-
└──────┬──────┘
144-
145-
┌────────────────┴────────────────┐
146-
147-
┌──────────┐ ┌──────────┐ ┌──────────┐
148-
Float Integer Bytes
149-
[0.0,1.0) [a, b] n
150-
└──────────┘ └──────────┘ └──────────┘
151-
└─────────────────────────────────────────────────────────────┘
121+
+-------------------------------------------------------------+
122+
| ENTROPY HARVESTERS |
123+
| +----------+ +----------+ +----------+ +--------------+ |
124+
| | Timing | | Network | | System | | External | |
125+
| | Jitter | | Latency | | State | | APIs | |
126+
| +----+-----+ +----+-----+ +----+-----+ +------+-------+ |
127+
| | | | | |
128+
| +------------+-----+------+--------------+ |
129+
| v |
130+
| +-----------+ |
131+
| | MIXER | SHA-256 Hashing |
132+
| | (Whitening)| Avalanche Effect |
133+
| +-----+-----+ |
134+
| v |
135+
| +-----------------------+ |
136+
| | ENTROPY POOL | 4096 bits |
137+
| | (Accumulated State) | Thread-safe |
138+
| +-----------+-----------+ |
139+
| v |
140+
| +-----------+ |
141+
| | EXTRACTOR | Secure extraction |
142+
| | (Tap) | Depletion protection |
143+
| +-----+-----+ |
144+
| v |
145+
| +---------------+--------------+ |
146+
| v v v |
147+
| +----------+ +----------+ +----------+ |
148+
| | Float | | Integer | | Bytes | |
149+
| | [0.0,1.0)| | [a, b] | | n | |
150+
| +----------+ +----------+ +----------+ |
151+
+-------------------------------------------------------------+
152152
```
153153

154154
## Security Considerations
@@ -163,8 +163,8 @@ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md)
163163

164164
```bash
165165
# Clone the repository
166-
git clone https://github.com/trueentropy/trueentropy.git
167-
cd trueentropy
166+
git clone https://github.com/medeirosdev/TrueEntropy-PyLib.git
167+
cd TrueEntropy-PyLib
168168

169169
# Install development dependencies
170170
pip install -e ".[dev]"
@@ -191,4 +191,4 @@ Inspired by:
191191

192192
---
193193

194-
**TrueEntropy** - *Because the universe is the best random number generator.* 🌌
194+
**TrueEntropy** - *Because the universe is the best random number generator.*

0 commit comments

Comments
 (0)