Skip to content

Commit dc5b50b

Browse files
authored
Update README file
1 parent cb735bf commit dc5b50b

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Unified Storage Library
1+
# 💾 Unified Storage Library
22

33
[![Check Arduino](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/check-arduino.yml) [![Compile Examples](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/compile-examples.yml) [![Spell Check](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/spell-check.yml) [![Sync Labels](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/sync-labels.yml)
44

@@ -10,7 +10,7 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
1010
* [**examples/AdvancedUSBInternalOperations**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/AdvancedUSBInternalOperations/AdvancedUSBInternalOperations.ino) - Navigate file structure and demonstrate file operations between USB and internal storage
1111
* [**examples/BackupInternalPartitions**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/BackupInternalPartitions/BackupInternalPartitions.ino) - Back up all partitions on the internal storage to a USB Mass Storage device.
1212

13-
## Instructions
13+
## 👀 Instructions
1414
1. Download and install this library
1515
2. Check compatibility with your platform
1616
3. To use internal storage, you need to make sure it is partitioned and formatted correctly:
@@ -28,7 +28,7 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
2828
* When asked if you'd like to use LittleFS on the data partition, select "n". Most of the examples assume that the drive is formatted as FAT. You can use the library to format to LittleFS later.
2929
* Reboot the board
3030

31-
## Features
31+
## Features
3232
* Access files and directories on internal storage, SD cards, and USB mass storage devices.
3333
* Read and write data to files.
3434
* Create, remove, and rename files and directories.
@@ -47,4 +47,8 @@ This library has been tested with the following STM32 and Renesas based Arduino
4747
* Opta: Internal QSPI Flash and USB
4848

4949

50-
Note: Due to an unforeseen compatibility issue on the Portenta Breakout Board, inserting a USB drive on the USB-A port of the breakout board may occasionally cause a reboot on Portenta C33 boards. You can work around this issue by connecting your USB Mass Storage device through a USB hub. This limitation only affects Portenta C33 boards.
50+
Note: Due to an unforeseen compatibility issue on the Portenta Breakout Board, inserting a USB drive on the USB-A port of the breakout board may occasionally cause a reboot on Portenta C33 boards. You can work around this issue by connecting your USB Mass Storage device through a USB hub. This limitation only affects Portenta C33 boards.
51+
52+
## 📖 Documentation
53+
54+
For more information about this library please read the documentation [here](./docs).

0 commit comments

Comments
 (0)