diff --git a/NeoBitmapFile-object-API.md b/NeoBitmapFile-object-API.md index f72372a..cf7f488 100644 --- a/NeoBitmapFile-object-API.md +++ b/NeoBitmapFile-object-API.md @@ -1,4 +1,6 @@ -NeoBitmapFile represents a image container object that retrieves pixels from a bmp file. The primary use of this class is to contain reference an image from a file and have it rendered to a NeoPixelBus. +NeoBitmapFile represents a image container object that retrieves pixels from a bmp file. The primary use of this class is to contain an image meta data and read from a file when it renders it to a NeoPixelBus. + +**[There is a known issue with SPIFSS on ESP8266 and a workaround](https://github.com/Makuna/NeoPixelBus/issues/317)** ## Constructors