summaryrefslogtreecommitdiffstats
path: root/vendor/xattr/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/xattr/README.md')
-rw-r--r--vendor/xattr/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/vendor/xattr/README.md b/vendor/xattr/README.md
new file mode 100644
index 000000000..ca1616f4e
--- /dev/null
+++ b/vendor/xattr/README.md
@@ -0,0 +1,22 @@
+xattr
+=====
+
+[![Build Status](https://travis-ci.org/Stebalien/xattr.svg?branch=master)](https://travis-ci.org/Stebalien/xattr)
+[![Build Status](https://api.cirrus-ci.com/github/Stebalien/xattr.svg)](https://cirrus-ci.com/github/Stebalien/xattr)
+
+A small library for setting, getting, and listing extended attributes.
+
+Supported Platforms: Android, Linux, MacOS, FreeBSD, and NetBSD.
+
+API Documentation: https://stebalien.github.com/xattr/xattr/
+
+Unsupported Platforms
+--------------------------
+
+This library includes no-op support for unsupported platforms. That is, it will
+build on *all* platforms but always fail on unsupported platforms.
+
+1. You can turn this off by disabling the default `unsupported` feature. If you
+ do so, this library will fail to compile on unsupported platforms.
+2. Alternatively, you can detect unsupported platforms at runtime by checking
+ the `xattr::SUPPORTED_PLATFORM` boolean.