aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortomaka <pierre.krieger1708@gmail.com>2015-02-15 18:28:12 +0100
committertomaka <pierre.krieger1708@gmail.com>2015-02-15 18:28:12 +0100
commitcd155ce8ea5a90c973ab5a421116ceb5e819b3e2 (patch)
treebb85b75b8bcdf2f6b49e5dc4dafb5fe875dda189
parent8a8cf72492fdd7e6b4b7f33ddbb2d7c90af5d0cc (diff)
downloadglutin-cd155ce8ea5a90c973ab5a421116ceb5e819b3e2.tar.gz
glutin-cd155ce8ea5a90c973ab5a421116ceb5e819b3e2.zip
Update README.md
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8188add..596af94 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,18 @@ Alternative to GLFW in pure Rust.
[![Build Status](https://travis-ci.org/tomaka/glutin.png?branch=master)](https://travis-ci.org/tomaka/glutin)
[![Build status](https://ci.appveyor.com/api/projects/status/cv5xewg3uchb3854/branch/master?svg=true)](https://ci.appveyor.com/project/tomaka/glutin/branch/master)
+```toml
+[dependencies]
+glutin = "*"
+```
+
+Note that the crates.io version won't compile on OS/X and Android because the required dependencies haven't been uploaded yet. Instead you can use the git version which works everywhere:
+
+```toml
+[dependencies.glutin]
+git = "https://github.com/tomaka/glutin"
+```
+
## [Documentation](http://tomaka.github.io/glutin/)
## Try it!