Publish preparation

Author: denzp

Cargo.toml

@@ -1,7 +1,18 @@
 [package]
 name = "rustc-llvm-proxy"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["Denys Zariaiev <denys.zariaiev@gmail.com>"]
+license = "MIT"
+
+readme = "README.md"
+repository = "https://github.com/denzp/rustc-llvm-proxy"
+categories = ["development-tools::build-utils", "external-ffi-bindings"]
+keywords = ["llvm"]
+
+[badges]
+appveyor = { repository = "denzp/rustc-llvm-proxy", branch = "master", service = "github" }
+travis-ci = { repository = "denzp/rustc-llvm-proxy", branch = "master" }
+maintenance = { status = "passively-maintained" }
 
 [dependencies]
 libloading = "0.5"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Denys Zariaiev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+# Rustc LLVM Proxy
+
+[![Build Status](https://travis-ci.org/denzp/rustc-llvm-proxy.svg?branch=master)](https://travis-ci.org/denzp/rustc-llvm-proxy)
+[![Build status](https://ci.appveyor.com/api/projects/status/4oxi872d3nir8ndk?svg=true)](https://ci.appveyor.com/project/denzp/rustc-llvm-proxy)
+[![Current Version](https://img.shields.io/crates/v/rustc-llvm-proxy.svg)](https://crates.io/crates/rustc-llvm-proxy)
+
+Dynamically proxy LLVM calls into Rust own shared library! 🎉
+
+## Use cases
+Normally there is no much need for the crate, except a couple of exotic cases:
+
+* Your crate is some kind build process helper that leverages LLVM (e.g. [ptx-linker](https://github.com/denzp/rust-ptx-linker)),
+* Your crate needs to stay up to date with Rust LLVM version (again [ptx-linker](https://github.com/denzp/rust-ptx-linker)),
+* You would prefer not to have dependencies on host LLVM libs (as always [ptx-linker](https://github.com/denzp/rust-ptx-linker)).
+
+## Usage
+First, you need to make sure no other crate links your binary against system LLVM library.
+In case you are using `llvm-sys`, this can be achieved with custom repo and a special feature:
+
+``` toml
+[dependencies.llvm-sys]
+git = "https://github.com/denzp/llvm-sys.rs.git"
+features = ["no-llvm-linking"]
+```
+
+Then all you need to do is to include the crate into your project:
+
+``` toml
+[dependencies]
+rustc-llvm-proxy = "0.1"
+```
+
+``` rust
+extern crate rustc_llvm_proxy;
+```

src/lib.rs

@@ -1,6 +1,36 @@
 #![deny(warnings)]
 #![allow(non_snake_case)]
 
+//! Dynamically proxy LLVM calls into Rust own shared library! 🎉
+//!
+//! ## Use cases
+//! Normally there is no much need for the crate, except a couple of exotic cases:
+//!
+//! * Your crate is some kind build process helper that leverages LLVM (e.g. [ptx-linker](https://github.com/denzp/rust-ptx-linker)),
+//! * Your crate needs to stay up to date with Rust LLVM version (again [ptx-linker](https://github.com/denzp/rust-ptx-linker)),
+//! * You would prefer not to have dependencies on host LLVM libs (as always [ptx-linker](https://github.com/denzp/rust-ptx-linker)).
+//!
+//! ## Usage
+//! First, you need to make sure no other crate links your binary against system LLVM library.
+//! In case you are using `llvm-sys`, this can be achieved with custom repo and a special feature:
+//!
+//! ``` toml
+//! [dependencies.llvm-sys]
+//! git = "https://github.com/denzp/llvm-sys.rs.git"
+//! features = ["no-llvm-linking"]
+//! ```
+//!
+//! Then all you need to do is to include the crate into your project:
+//!
+//! ``` toml
+//! [dependencies]
+//! rustc-llvm-proxy = "0.1"
+//! ```
+//!
+//! ``` rust
+//! extern crate rustc_llvm_proxy;
+//! ```
+
 #[macro_use]
 extern crate lazy_static;
 #[macro_use]