From 59bfbc91c51a892a7cfb06da3d90b82104168972 Mon Sep 17 00:00:00 2001 From: Bob Rudis Date: Sat, 13 Aug 2016 12:12:43 -0400 Subject: [PATCH] README --- README.Rmd | 6 ++++-- README.md | 13 +++++++++++-- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README.Rmd b/README.Rmd index 3f5dddb..8f0060a 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,6 +1,8 @@ --- output: rmarkdown::github_document --- +[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/0.1.0/active.svg)](http://www.repostatus.org/#active) +[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/wand.svg?branch=master)](https://travis-ci.org/hrbrmstr/wand) `wand` : Retrieve 'Magic' Attributes from Files and Directories @@ -9,9 +11,9 @@ The `libmagic` library must be installed and available to use this. - `apt-get install libmagic-dev` on Debian-ish systems - `brew install libmagic` on macOS -Minimum expected version of `libmagic` is 5.28 but it should work with older versions. Note that some fields in the resultant data frame might not be available with older library versions. +While the package was developed using the 5.28 version of `libmagic` it has been configured to work with older versions. Note that some fields in the resultant data frame might not be available with older library versions. When using the function `magic_wand_file()` it checks for which version of `libmagic` is installed on your system and provides a suitable `magic.mgc` file for it. -The package should also be pretty straightforward to get working on Windows. Assistance to do that is welcome. +The package should also be pretty straightforward to get working on Windows. Assistance to do that is welcome. Think of all the fame and glory you'll receive! The following functions are implemented: diff --git a/README.md b/README.md index ac42a67..aefbf48 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ +[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/0.1.0/active.svg)](http://www.repostatus.org/#active) [![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/wand.svg?branch=master)](https://travis-ci.org/hrbrmstr/wand) + `wand` : Retrieve 'Magic' Attributes from Files and Directories -The `libmagic` library must be installed and available to use this. The package should also be pretty straightforward to get working on Windows. Assistance to do that is welcome. +The `libmagic` library must be installed and available to use this. + +- `apt-get install libmagic-dev` on Debian-ish systems +- `brew install libmagic` on macOS + +While the package was developed using the 5.28 version of `libmagic` it has been configured to work with older versions. Note that some fields in the resultant data frame might not be available with older library versions. When using the function `magic_wand_file()` it checks for which version of `libmagic` is installed on your system and provides a suitable `magic.mgc` file for it. + +The package should also be pretty straightforward to get working on Windows. Assistance to do that is welcome. Think of all the fame and glory you'll receive! The following functions are implemented: @@ -70,7 +79,7 @@ library(testthat) date() ``` - ## [1] "Fri Aug 12 23:58:20 2016" + ## [1] "Sat Aug 13 12:12:14 2016" ``` r test_dir("tests/")