yetangitu/ffsend
1
0
Fork 0
mirror of https://github.com/timvisee/ffsend.git synced 2025-10-03 09:39:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

Minor README tweaks

Browse source
This commit is contained in:
timvisee 2020-01-27 14:00:15 +01:00
parent 9299ec04eb
commit e73f5d08b4
No known key found for this signature in database
GPG key ID: B8DB720BC383E172
1 changed files with 11 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -8,7 +8,8 @@
[gitlab-ci-link]: https://gitlab.com/timvisee/ffsend/pipelines [gitlab-ci-link]: https://gitlab.com/timvisee/ffsend/pipelines
[gitlab-ci-master-badge]: https://gitlab.com/timvisee/ffsend/badges/master/pipeline.svg [gitlab-ci-master-badge]: https://gitlab.com/timvisee/ffsend/badges/master/pipeline.svg
# ffsend [WIP] # ffsend
> Easily and securely share files from the command line. > Easily and securely share files from the command line.
> A fully featured [Firefox Send][send] client. > A fully featured [Firefox Send][send] client.
@ -44,23 +45,21 @@ The public [Send][send] service that is used as default host is provided by
This application is not affiliated with [Mozilla][mozilla], [Firefox][firefox] This application is not affiliated with [Mozilla][mozilla], [Firefox][firefox]
or [Firefox Send][send] in any way. or [Firefox Send][send] in any way.
_Note: this tool is currently in alpha_ _Note: this tool is currently in beta, as some extra desired features are yet to be implemented_
## Features ## Features
- Fully featured and friendly command line tool - Fully featured and friendly command line tool
- Upload and download files and directories securely - Upload and download files and directories securely, always encrypted on the client
- Always encrypted on the client
- Additional password protection, generation and configurable download limits - Additional password protection, generation and configurable download limits
- File and directory archiving and extraction - File and directory archiving and extraction
- Built-in share URL shortener and QR code generator - Built-in share URL shortener and QR code generator
- Supports old and new Firefox Send server versions - Supports Firefox Send v3 (current) and v2
- History tracking your files for easy management - History tracking your files for easy management
- Ability to use custom Send hosts - Ability to use your own Send hosts
- Inspect or delete shared files - Inspect or delete shared files
- Accurate error reporting - Accurate error reporting
- Streaming encryption and uploading/downloading, very low memory footprint - Streaming encryption and uploading/downloading, very low memory footprint
- Intended for use in [scripts](#scriptability) without interaction - Intended for use in [scripts](#scriptability) without interaction
- Upcoming: Firefox Account integration (higher download counts, longer expiry times)
For a list of upcoming features and ideas, take a look at the For a list of upcoming features and ideas, take a look at the
current [open issues](https://gitlab.com/timvisee/ffsend/issues) over on GitLab. current [open issues](https://gitlab.com/timvisee/ffsend/issues) over on GitLab.
@ -131,9 +130,9 @@ Use the `--help` flag, `help` subcommand, or see the [help](#help) section for
all available subcommands. all available subcommands.
## Requirements ## Requirements
- Linux, macOS, Windows or FreeBSD (other BSDs might work) - Linux, macOS, Windows, FreeBSD, Android (other BSDs might work)
- A terminal :sunglasses: - A terminal :sunglasses:
- Internet connection for uploading and downloading - Internet connection
- Linux: - Linux:
- OpenSSL & CA certificates: - OpenSSL & CA certificates:
- Ubuntu, Debian and derivatives: `apt install openssl ca-certificates` - Ubuntu, Debian and derivatives: `apt install openssl ca-certificates`
@ -153,8 +152,8 @@ all available subcommands.
- Termux: [» Termux][termux] - Termux: [» Termux][termux]
## Install ## Install
Because `ffsend` is still in alpha, only limited installation options are Because `ffsend` is still in early stages, only limited installation options are
available right now. available right now. Feel free to contribute additional packages.
Make sure you meet and install the [requirements](#requirements). Make sure you meet and install the [requirements](#requirements).
@ -437,7 +436,7 @@ To build and install `ffsend` yourself, you meet the following requirements
before proceeding: before proceeding:
### Build requirements ### Build requirements
- Regular [requirements](#requirements) - Runtime [requirements](#requirements)
- [`git`][git] - [`git`][git]
- [`rust`][rust] `v1.39` or higher (install using [`rustup`][rustup]) - [`rust`][rust] `v1.39` or higher (install using [`rustup`][rustup])
- [OpenSSL][openssl] or [LibreSSL][libressl] libraries and headers must be available - [OpenSSL][openssl] or [LibreSSL][libressl] libraries and headers must be available