Skip to content

Commit e6dcce7

Browse files
committed
Use absolute image URLs in README
This way they should show up on PlaformIO.
1 parent e4fa59c commit e6dcce7

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ How to add buffering to a Stream?
3939
Sometimes, you can significantly improve performance by reading many bytes at once.
4040
For example, [according to SPIFFS's wiki](https://github.com/pellepl/spiffs/wiki/Performance-and-Optimizing#reading-files), reading read files in chunks of 64 bytes is much faster than reading them one byte at a time.
4141

42-
![ReadBufferingStream](extras/images/ReadBuffer.svg)
42+
![ReadBufferingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/ReadBuffer.svg)
4343

4444
To buffer the input, decorate the original `Stream` with `ReadBufferingStream`. For example, suppose your program reads a JSON document from SPIFFS like that:
4545

@@ -72,7 +72,7 @@ Adding a buffer only makes sense for **unbuffered** streams. For example, there
7272
Similarly, you can improve performance significantly by writing many bytes at once.
7373
For example, writing to `WiFiClient` one byte at a time is very slow; it's much faster if you send large chunks.
7474

75-
![WriteBufferingStream](extras/images/WriteBuffer.svg)
75+
![WriteBufferingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/WriteBuffer.svg)
7676

7777
To add a buffer, decorate the original `Stream` with `WriteBufferingStream`. For example, if your program sends a JSON document via `WiFiClient`, like that:
7878

@@ -101,7 +101,7 @@ How to add logging to a stream?
101101

102102
When debugging a program that makes HTTP requests, you first want to check whether the request is correct. With this library, you can decorate the `EthernetClient` or the `WiFiClient` to log everything to the serial.
103103

104-
![WriteLoggingStream](extras/images/WriteLogger.svg)
104+
![WriteLoggingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/WriteLogger.svg)
105105

106106
For example, if your program is:
107107

@@ -127,7 +127,7 @@ Everything you write to `loggingClient` is written to `client` and logged to `Se
127127
128128
Similarly, you often want to see what the HTTP server sent back. With this library, you can decorate the `EthernetClient` or the `WiFiClient` to log everything to the serial.
129129
130-
![ReadLoggingStream](extras/images/ReadLogger.svg)
130+
![ReadLoggingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/ReadLogger.svg)
131131
132132
For example, if your program is:
133133
@@ -154,7 +154,7 @@ If your program receives data from one serial port and logs to another, **ensure
154154
155155
Of course, you could log read and write operations by combining `ReadLoggingStream` and `WriteLoggingStream`, but there is a simpler solution: `LoggingStream`.
156156
157-
![LoggingStream](extras/images/Logger.svg)
157+
![LoggingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/Logger.svg)
158158
159159
As usual, if your program is:
160160
@@ -195,7 +195,7 @@ Serial1.begin(9600, SERIAL_7N1);
195195

196196
The class `HammingEncodingStream<7, 4>` decorates an existing `Stream` to include parity bits in every write operation.
197197

198-
![HammingEncodingStream](extras/images/HammingEncodingStream.svg)
198+
![HammingEncodingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/HammingEncodingStream.svg)
199199

200200
You can use this class like so:
201201

@@ -211,7 +211,7 @@ Like every `Stream` decorator in this library, `HammingEncodingStream<7, 4>` sup
211211
212212
The class `HammingDecodingStream<7, 4>` decorates an existing `Stream` to decode parity bits in every read operation.
213213
214-
![HammingDecodingStream](extras/images/HammingDecodingStream.svg)
214+
![HammingDecodingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/HammingDecodingStream.svg)
215215
216216
You can use this class like so:
217217
@@ -228,7 +228,7 @@ Like every `Stream` decorator in this library, `HammingDecodingStream<7, 4>` sup
228228

229229
The class `HammingStream<7, 4>` combines the features of `HammingEncodingStream<7, 4>` and `HammingDecodingStream<7, 4>`, which is very useful when you do two-way communication.
230230

231-
![HammingStream](extras/images/HammingStream.svg)
231+
![HammingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/HammingStream.svg)
232232

233233
You can use this class like so:
234234

@@ -250,7 +250,7 @@ How to retry write operations?
250250
Sometimes, a stream is limited to the capacity of its internal buffer. In that case, you must wait before sending more data.
251251
To solve this problem, StreamUtils provides the `WriteWaitingStream` decorator:
252252
253-
![WriteWaitingStream](extras/images/WriteWaitingStream.svg)
253+
![WriteWaitingStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/WriteWaitingStream.svg)
254254
255255
This function repeatedly waits and retries until it times out.
256256
You can customize the `wait()` function; by default, it's [`yield()`](https://www.arduino.cc/en/Reference/SchedulerYield).
@@ -279,7 +279,7 @@ How to use a `String` as a stream?
279279
Sometimes, you use a piece of code that expects a `Print` instance (like `ReadLoggingStream`), but you want the output in a `String` instead of a regular `Stream`.
280280
In that case, use the `StringPrint` class. It wraps a `String` within a `Print` implementation.
281281

282-
![StringPrint](extras/images/StringPrint.svg)
282+
![StringPrint](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/StringPrint.svg)
283283

284284
Here is how you can use it:
285285

@@ -303,15 +303,15 @@ Temperature = 22.30 °C
303303

304304
Similarly, there are cases where you have a `String`, but you need to pass a `Stream` to some other piece of code. In that case, use `StringStream`; it's similar to `StrintPrint`, except you can also read from it.
305305

306-
![StringStream](extras/images/StringStream.svg)
306+
![StringStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/StringStream.svg)
307307

308308

309309
How to use EEPROM as a stream?
310310
------------------------------
311311

312312
SteamUtils also allows using EEPROM as a stream. Create an instance of `EepromStream` and specify the start address and the size of the region you want to expose.
313313

314-
![EepromStream](extras/images/EepromStream.svg)
314+
![EepromStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/EepromStream.svg)
315315

316316
For example, it allows you to save a JSON document in EEPROM:
317317

@@ -334,7 +334,7 @@ How to use `PROGMEM` as a stream?
334334

335335
SteamUtils also allows reading `PROGMEM` buffers with a `Stream` interface.
336336

337-
![ProgmemStream](extras/images/ProgmemStream.svg)
337+
![ProgmemStream](https://github.com/bblanchon/ArduinoStreamUtils/raw/master/extras/images/ProgmemStream.svg)
338338

339339
Create an instance of `ProgmemStream` and pass the pointer to the `PROGMEM` buffer.
340340

0 commit comments

Comments
 (0)