Update to the readme, incorporating some suggestions by Caleb Bassi

Byron · Sep 25, 2020 · 9bddccc · 9bddccc
1 parent c49b496
commit 9bddccc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,7 +4,7 @@ version = "1.1.1"
 authors = ["Artur Kovacs <[email protected]>"]
 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
@@ -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