Skip to content

Commit

Permalink
docs: Future of wincs
Browse files Browse the repository at this point in the history
  • Loading branch information
ok-nick authored May 23, 2023
1 parent 3dcc069 commit 416d00b
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
</p>
</div>

> **Warning**
> Read more about the future of `wincs` in [issue #8](https://github.com/ok-nick/wincs/issues/8).
`wincs` is a safe and idiomatic wrapper around the native [Windows Cloud Filter API](https://docs.microsoft.com/en-us/windows/win32/cfapi/build-a-cloud-file-sync-engine). The Cloud Filter API enables developers to implement their own remote file system from within user space. It is much like [FUSE](#why-not-fuse), although it contains many first-class Windows features that are only available through its API.
For example:
* [Placeholder files](#what-are-placeholders)
Expand Down Expand Up @@ -37,11 +40,6 @@ For example:

As of right now, the Cloud Filter API is used in production by OneDrive, Google Drive, Dropbox, and many other clients.

## TODO
Documentation needs to be added and refined. Grep `TODO` to find a list of unsolved issues. In addition, there are many unimplemented features included with `TODO` comments. The API is subject to change and I am open to opinions for change. The [examples directory](https://github.com/ok-nick/wincs/tree/main/examples) is outdated and needs refinement, as well as commenting. CI and CD are also needed.

If anyone is interested in contributing, feel free to leave an issue or PR.

## Examples
Below is a simple snippet of implementing a sync engine. For more, in-depth examples, please check out the [examples directory](https://github.com/ok-nick/wincs/tree/main/examples).
```rs
Expand Down

0 comments on commit 416d00b

Please sign in to comment.