summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAbinoam Praxedes Marques Jr <abinoam@gmail.com>2015-10-07 22:56:32 -0300
committerAbinoam Praxedes Marques Jr <abinoam@gmail.com>2015-10-09 23:33:48 -0300
commit36d5ead9d29ec107a55bae8c5b254fe4c3ba54a4 (patch)
treeb8a44ef77ca7700a340cf4018923deed96183517 /README.md
parentf607c67b63cb9a0cf8abafcef999b9d87edae5ee (diff)
downloadhighline-36d5ead9d29ec107a55bae8c5b254fe4c3ba54a4.tar.gz
Update INSTALL instructions on README.md
... and remove the separate (outdated) INSTALL file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3f3e052..9db95c1 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,38 @@ HighLine from version >= 1.7.0 requires ruby >= 1.9.3
Installing
----------
-See the [INSTALL](INSTALL) file for instructions.
+To install HighLine, use the following command:
+
+```sh
+$ gem install highline
+```
+
+(Add `sudo` if you're installing under a POSIX system as root)
+
+If you're using [Bundler](http://bundler.io/), add this to your Gemfile:
+
+```ruby
+source "https://rubygems.org"
+gem 'highline'
+```
+
+And then run:
+
+```sh
+$ bundle
+```
+
+If you want to build the gem locally, use the following command from the root of the sources:
+
+```sh
+$ rake package
+```
+
+You can also build and install directly:
+
+```sh
+$ rake install
+```
Questions and/or Comments
-------------------------