Skip to content

Commit

Permalink
[CARGO] - Improve doc before publish version 1.0.2
Browse files Browse the repository at this point in the history
[+] Adding changelog section in Readme file
[*] change version in readme file
[*] Adding error and success handling in readme file

[*] Update version in cargo.toml
[*] Cargo require to use maximum 5 keyword
  • Loading branch information
Sans-Atout committed Jun 26, 2022
1 parent 763386f commit 001bcce
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 8 deletions.
7 changes: 5 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
[package]
name = "nozomi"
version = "1.0.1"
version = "1.0.2"
edition = "2021"

authors = ["Sans-Atout <augustin.rousset-rouviere@isep.fr>"]
description = "A rust wipper library"
description = "Equivalent of the Linux shred command but in rust and library. Allows you to securely erase data from a hard drive."
keywords = ["security", "erase","eraser", "wipping", "wipper"]

license = "GPL-3.0"
repository = "https://github.com/Sans-Atout/Nozomi/"

Expand Down
44 changes: 38 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ A Rust librairy that wipe all file or folder. \
This library includes most of the secure deletion methods of the [Eraser](https://eraser.heidi.ie) for Windows software.

# Add to your project

```
[dependencies]
nozomi = "1.0.0"
nozomi = "1.0.2"
```

## Code example
Expand All @@ -16,7 +15,10 @@ nozomi = "1.0.0"
use nozomi;

fn main() {
nozomi::erase_file("path_to_file", nozomi::EraserEntity::PseudoRandom);
match nozomi::erase_file("path_to_file", nozomi::EraserEntity::PseudoRandom){
Ok(info) => println!("{}",info),
Err(error) => println!("{}",error)
};
}
```

Expand All @@ -25,13 +27,43 @@ fn main() {
use nozomi;

fn main() {
nozomi::erase_folder("path_to_folder", nozomi::EraserEntity::PseudoRandom);
match nozomi::erase_folder("path_to_folder", nozomi::EraserEntity::PseudoRandom){
Ok(info) => println!("{}",info),
Err(error) => println!("{}",error)
};
}
```
# Changelog
## [v1.0.2](https://crates.io/crates/nozomi/1.0.2)
```
[+] Update Readme file
[B] Correct a bug in erase_folder function
[C] When a folder is found in erase folder function, the function crash
because a folder is not a file
[+] Adding error handling
[+] Adding success handling
```

## [v1.0.1](https://crates.io/crates/nozomi/1.0.1)
```
[+] Update Readme file
```
# Erase Method
Here are the methods implemented or to be implemented in this library

## [v1.0.0](https://crates.io/crates/nozomi/1.0.0)
```
[+] Adding erase file method
[+] Pseudo Random
[+] Gutmann
[+] HMGI S5
[+] DOD 522022 MECE
[+] DOD 522022 ME
[+] AFSSI 5020
[+] RCMP TSSIT OPS II
[+] Adding erase folder method
```

# Erase Method
## [Pseudo Random](https://www.lifewire.com/data-sanitization-methods-2626133#toc-random-data)

| Pass number | Patern |
Expand Down

0 comments on commit 001bcce

Please sign in to comment.