aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChih-Hung Hsieh <chh@google.com>2020-04-07 14:24:03 -0700
committerChih-Hung Hsieh <chh@google.com>2020-04-07 14:28:23 -0700
commit55629747c3beca7abbdd157e757f695a7afa3731 (patch)
tree50fb0b53a7a97197d5529f07d42d09e674a56e17 /README.md
parentb5ea820568738bb078456ba5befe3f8093e0aeb7 (diff)
downloadthread_local-55629747c3beca7abbdd157e757f695a7afa3731.tar.gz
Import 'thread_local' package version 1.0.1platform-tools-30.0.0
* Add OWNERS * No Android.bp yet Bug: 152884384 Test: make Change-Id: I50daca2484475354a0f7696a1ad755a0738697c3
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d00355b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+thread_local
+============
+
+[![Build Status](https://travis-ci.org/Amanieu/thread_local-rs.svg?branch=master)](https://travis-ci.org/Amanieu/thread_local-rs) [![Crates.io](https://img.shields.io/crates/v/thread_local.svg)](https://crates.io/crates/thread_local)
+
+This library provides the `ThreadLocal` and `CachedThreadLocal` types which
+allow a separate copy of an object to be used for each thread. This allows for
+per-object thread-local storage, unlike the standard library's `thread_local!`
+macro which only allows static thread-local storage.
+
+[Documentation](https://amanieu.github.io/thread_local-rs/thread_local/index.html)
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+thread_local = "1.0"
+```
+
+and this to your crate root:
+
+```rust
+extern crate thread_local;
+```
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.