https://github.com/zhanghai/filesystem-kt

Multiplatform Kotlin library for accessing files and file systems
https://github.com/zhanghai/filesystem-kt

file-system kotlin kotlin-library kotlin-multiplatform

Last synced: 2 months ago
JSON representation

Multiplatform Kotlin library for accessing files and file systems

• Host: GitHub
• URL: https://github.com/zhanghai/filesystem-kt
• Owner: zhanghai
• License: apache-2.0
• Created: 2024-04-30T02:53:31.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-10-24T06:36:52.000Z (3 months ago)
• Last Synced: 2024-10-25T01:45:20.616Z (3 months ago)
• Topics: file-system, kotlin, kotlin-library, kotlin-multiplatform
• Language: Kotlin
• Homepage: https://zhanghai.github.io/filesystem-kt/api/
• Size: 619 KB
• Stars: 17
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# filesystem-kt

[![CI status](https://github.com/zhanghai/filesystem-kt/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/zhanghai/filesystem-kt/actions) [![GitHub release](https://img.shields.io/github/v/release/zhanghai/filesystem-kt)](https://github.com/zhanghai/filesystem-kt/releases) [![License](https://img.shields.io/github/license/zhanghai/filesystem-kt?color=blue)](LICENSE) [![API reference](https://img.shields.io/badge/API_reference-KDoc-blue)](https://zhanghai.github.io/filesystem-kt/api)

A multiplatform Kotlin library for accessing files and file systems.

This project is still in work-in-progress state, which means that it is not published into public repository and not yet intended to use by end user.

This is not an officially supported Google product.

## Design

WIP

Watching files and walking file trees are still TBD.

## Documentation

See [API reference](https://zhanghai.github.io/filesystem-kt/api).

## Integration

WIP

```kotlin

dependencies {

    implementation("me.zhanghai.kotlin.filesystem:filesystem:0.0.1")

}

```

## License

    Copyright 2024 Google LLC

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.