Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dpc committed Jul 29, 2018
1 parent d1207dd commit 289bc04
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 25 deletions.
6 changes: 3 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rdedup"
version = "3.0.0"
version = "3.0.1"
authors = ["Dawid Ciężarkiewicz <dpc@dpc.pw>"]
description = "Data deduplication with compression and public key encryption. - binary"
keywords = ["data", "backup", "dedupliation", "encryption", "dedup"]
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ See [wiki](https://github.com/dpc/rdedup/wiki) for current project status.
`rdedup` is a data deduplication engine and a backup software.

`rdedup` is generally similar to existing software like
duplicacy, restic, attic, duplicity, zbackup, etc.
`duplicacy`, `restic`, `attic`, `duplicity`, `zbackup`, etc.

`rdedup` is written in Rust and provides both command line tool
and library API (`rdedup-lib`).
Expand All @@ -32,7 +32,8 @@ and library API (`rdedup-lib`).
* public-key encryption mode (the only tool like that I'm aware of,
and primary reason `rdedup` was created)
* flat-file synchronization friendly (Dropbox/syncthing, rsync, rclone)
* cloud backends are WIP
* immutable data-conflict-free data store
* cloud backends are WIP
* incremental, scalable garbage collection
* variety of supported algorithms:
* chunking: fastcdc, gear, bup
Expand All @@ -50,8 +51,7 @@ and library API (`rdedup-lib`).
### Strong parts

It's written in Rust. It's a modern language, that is actually really nice
to use.
Rust makes it easy to have a very robust and fast software.
to use. Rust makes it easy to have a very robust and fast software.

The author is a nice person, welcomes contributions, and helps users. Or at
least he's trying... :)
Expand All @@ -70,9 +70,9 @@ mostly implemented, but the actual backends are not.

If you have `cargo` installed:

```rust
cargo install rdedup --vers '^2' # for 2.x stable version
cargo install rdedup --vers '^3' # for 3.x experimental, and unstable version
```norust
cargo install rdedup
version
```

If not, I highly recommend installing [rustup][rustup] (think `pip`, `npm`
Expand All @@ -81,7 +81,7 @@ but for Rust)
If you're interested in running `rdedup` with maximum possible performance,
try:

```rust
```norust
RUSTFLAGS="-C target-cpu=native" cargo install rdedup --vers ...
```

Expand Down Expand Up @@ -115,7 +115,7 @@ Supported commands:
In combination with [rdup][rdup] this can be used to store and restore your
backup like this:

```rust
```norust
rdup -x /dev/null "$HOME" | rdedup store home
rdedup load home | rdup-up "$HOME.restored"
```
Expand Down
18 changes: 6 additions & 12 deletions src/bin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@
//! If you have `cargo` installed:
//!
//! ```norust
//! cargo install rdedup --vers '^2' # for 2.x stable version
//! cargo install rdedup --vers '^3' # for 3.x experimental, and unstable
//! cargo install rdedup
//! version
//! ```
//!
Expand Down Expand Up @@ -206,16 +205,13 @@ impl Options {

fn set_chunking(&mut self, s: &str, chunk_size: Option<u32>) {
match s {
"bup" => self
.settings
"bup" => self.settings
.use_bup_chunking(chunk_size)
.expect("wrong chunking settings"),
"gear" => self
.settings
"gear" => self.settings
.use_gear_chunking(chunk_size)
.expect("wrong chunking settings"),
"fastcdc" => self
.settings
"fastcdc" => self.settings
.use_fastcdc_chunking(chunk_size)
.expect("wrong chunking settings"),
_ => {
Expand All @@ -227,12 +223,10 @@ impl Options {

fn set_hashing(&mut self, s: &str) {
match s {
"sha256" => self
.settings
"sha256" => self.settings
.set_hashing(lib::settings::Hashing::Sha256)
.expect("wrong hashing settings"),
"blake2b" => self
.settings
"blake2b" => self.settings
.set_hashing(lib::settings::Hashing::Blake2b)
.expect("wrong hashing settings"),
_ => {
Expand Down

0 comments on commit 289bc04

Please sign in to comment.