# suparnatural-fs

# Introduction

A Kotlin Multiplatform library for iOS and Android to provide file system access.

# Setup

1. Add the repository to your project.

   repositories {
       mavenCentral()
   }
   

   1
   2
   3
   
2. Add implementation 'com.suparnatural.kotlin:fs:version' to commonMain.

With the hierarchical project structure, you generally need to add the dependency to commonMain only. Other targets are also available in case you need to override this behavior.

# Usage

Check out the API Docs. They are always up to date with code examples.

All APIs are accessible via thread-safe singleton FileSystem.

On Android, the FileSystem singleton requires a context. However, it is automatically initialized with the application context when the library loads. Therefore, you can just start using it.

FileSystem.exists("/var/file")
FileSystem.mkdir("/var/dir", recursive=true)