remotefs 0.0.0

# remotefs

<p align="center">
  <img src="/assets/images/remotefs.svg" width="256" height="256" />
</p>

<p align="center">~ The Omni Filetransfer Client Library (and more!) ~</p>
<p align="center">
  <a href="https://veeso.github.io/remotefs/" target="_blank">Website</a>
  ·
  <a href="https://veeso.github.io/remotefs/#get-started" target="_blank">Get started</a>
  ·
  <a href="https://docs.rs/remotefs" target="_blank">Documentation</a>
</p>

<p align="center">Developed by <a href="https://veeso.github.io/">@veeso</a></p>
<p align="center">Current version: 0.7.0 (FIXME: 31/08/2021)</p>

[![License: MIT](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/licenses/MIT) [![Stars](https://img.shields.io/github/stars/veeso/remotefs.svg)](https://github.com/veeso/remotefs) [![Downloads](https://img.shields.io/crates/d/remotefs.svg)](https://crates.io/crates/remotefs) [![Crates.io](https://img.shields.io/badge/crates.io-v0.7.0-orange.svg)](https://crates.io/crates/remotefs)  

[![Linux](https://github.com/veeso/remotefs/workflows/Linux/badge.svg)](https://github.com/veeso/remotefs/actions) [![MacOs](https://github.com/veeso/remotefs/workflows/MacOS/badge.svg)](https://github.com/veeso/remotefs/actions) [![Windows](https://github.com/veeso/remotefs/workflows/Windows/badge.svg)](https://github.com/veeso/remotefs/actions) [![FreeBSD](https://github.com/veeso/remotefs/workflows/FreeBSD/badge.svg)](https://github.com/veeso/remotefs/actions) [![Coverage Status](https://coveralls.io/repos/github/veeso/remotefs/badge.svg)](https://coveralls.io/github/veeso/remotefs) [![Docs](https://docs.rs/remotefs/badge.svg)](https://docs.rs/remotefs)

---

## About remotefs 💿

TODO:

---

## Features 🎁

- 📁  Different communication protocols
  - **SFTP**
  - **SCP**
  - **FTP** and **FTPS**
  - **Aws S3**

TODO:

---

## Get started 🚀

TODO:

### Requirements ❗

- **Linux** users:
  - SFTP/SCP
    - libssh
    - pkg-config
- **BSD** users:
  - SFTP/SCP
    - libssh
    - pkgconf

---

## Buy me a coffee ☕

If you like remotefs and you'd love to see the project to grow, please consider a little donation 🥳

[![Buy-me-a-coffee](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=&slug=veeso&button_colour=404040&font_colour=ffffff&font_family=Comic&outline_colour=ffffff&coffee_colour=FFDD00)](https://www.buymeacoffee.com/veeso)

---

## User manual and Documentation 📚

The user manual can be found on the [remotefs's website](https://veeso.github.io/remotefs/#user-manual) or on Github:

- [User manual](docs/man-en.md)
- [用户手册](docs/man-zh.md)

A translation of the user manual in other languages would be really appreciated 😉

The developer documentation can be found on Rust Docs at <https://docs.rs/remotefs>

---

## Contributing and issues 🤝🏻

Contributions, bug reports, new features and questions are welcome! 😉
If you have any question or concern, or you want to suggest a new feature, or you want just want to improve remotefs, feel free to open an issue or a PR.

An **appreciated** contribution would be a translation of the user manual and readme in **other languages**

Please follow [our contributing guidelines](CONTRIBUTING.md)

---

## Changelog ⏳

View remotefs's changelog [HERE](CHANGELOG.md)

---

## Powered by 💪

remotefs is powered by these aweseome projects:

- [rust-s3](https://github.com/durch/rust-s3)
- [ssh2-rs](https://github.com/alexcrichton/ssh2-rs)
- [suppaftp](https://github.com/veeso/suppaftp)
- [whoami](https://github.com/libcala/whoami)
- [wildmatch](https://github.com/becheran/wildmatch)

---

## License 📃

remotefs is licensed under the MIT license.

You can read the entire license [HERE](LICENSE)