From 9bddccc2e8e368f7278135e60d41da601fa20aa4 Mon Sep 17 00:00:00 2001 From: Artur Kovacs Date: Fri, 25 Sep 2020 09:36:13 +0200 Subject: [PATCH] Update to the readme, incorporating some suggestions by Caleb Bassi --- Cargo.toml | 2 +- README.md | 13 ++++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0d97f6a..cbe12f2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ version = "1.1.1" authors = ["Artur Kovacs "] license = "MIT" readme = "README.md" -description = "A Rust library for moving files to the Recycle Bin" +description = "A library for moving files and folders to the Recycle Bin" keywords = ["remove", "trash", "rubbish", "recycle", "bin"] repository = "https://github.com/ArturKovacs/trash" edition = "2018" diff --git a/README.md b/README.md index d98982a..b5df85d 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,22 @@ ## About -Trash is a Rust library that provides functionality to move files and folders to the operating system's Recycle Bin (or Trash or Rubbish Bin or what have you). +The `trash` is a Rust library for moving files and folders to the operating system's Recycle Bin or Trash or Rubbish Bin or what have you :D -The library supports Windows, Mac and Linux. +The library supports Windows, macOS, Linux, and BSD. ## Usage +```toml +# In Cargo.toml +[dependencies] +trash = "1.1" +``` + ```rust -extern crate trash; +// In main.rs use std::fs::File; +use trash; fn main() { // Let's create and remove a single file