Merge branch 'arduino-libraries:main' into main

Author: cristidragomir97

README.md

@@ -1,4 +1,4 @@
-# Unified Storage Library
+# 💾 Unified Storage Library 
 
 [![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)
 
@@ -10,7 +10,7 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
 * [**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
 * [**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.
 
-## Instructions
+## 👀 Instructions
 1. Download and install this library 
 2. Check compatibility with your platform
 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
 *  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. 
 *  Reboot the board
 
-## Features
+## ✨ Features
 * Access files and directories on internal storage, SD cards, and USB mass storage devices.
 * Read and write data to files.
 * Create, remove, and rename files and directories.
@@ -47,4 +47,8 @@ This library has been tested with the following STM32 and Renesas based Arduino
 * Opta: Internal QSPI Flash and USB
 
 
-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.
+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.
+
+## 📖 Documentation
+
+For more information about this library please read the documentation [here](./docs).

docs/api.md

@@ -336,7 +336,7 @@ Represents internal storage using the Arduino Unified Storage library.
 `public virtual ` [`Folder`](#class_folder)` ` [`getRootFolder`](#class_internal_storage_1a87142ddbdad62217e33851b32572082d)`()` | Retrieves the root folder of the internal storage.
 `public void ` [`setQSPIPartition`](#class_internal_storage_1a2ca8680537077ca3e189be2ca6dcc634)`(int partition)` | Sets the QSPI partition number.
 `public void ` [`setQSPIPartitionName`](#class_internal_storage_1ae0fbe264a758a4026548df66ec05f8c8)`(const char * name)` | Sets the QSPI partition name.
-`public virtual bool ` [`format`](#class_internal_storage_1a9ee819a55de5d411e6b10bdc9942c601)`(FileSystems fs)` | Formats the internal storage with the selceted file system.
+`public virtual bool ` [`format`](#class_internal_storage_1a9ee819a55de5d411e6b10bdc9942c601)`(FileSystems fs)` | Formats the internal storage with the selected file system.
 
 ## Members
 
@@ -410,7 +410,7 @@ Sets the QSPI partition name.
 
 ### `public virtual bool ` [`format`](#class_internal_storage_1a9ee819a55de5d411e6b10bdc9942c601)`(FileSystems fs)` <a id="class_internal_storage_1a9ee819a55de5d411e6b10bdc9942c601" class="anchor"></a>
 
-Formats the internal storage with the selceted file system.
+Formats the internal storage with the selected file system.
 
 #### Returns
 true if successful, false if failed.

src/InternalStorage.h

@@ -68,7 +68,7 @@ class InternalStorage : public Arduino_UnifiedStorage {
     void setQSPIPartitionName(const char *name);
 
     /**
-     * Formats the internal storage with the selceted file system.
+     * Formats the internal storage with the selected file system.
      * 
      * @return true if successful, false if failed.
      */