From 0d2b6145063ad60491d01051a024a0e817c1f7f4 Mon Sep 17 00:00:00 2001
From: Max Ogden <max@maxogden.com>
Date: Mon, 20 Oct 2014 13:36:12 +0900
Subject: [PATCH] update readme

---
 npm/README.md | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/npm/README.md b/npm/README.md
index 64993685d5..5ed67e5c05 100644
--- a/npm/README.md
+++ b/npm/README.md
@@ -1,8 +1,35 @@
 # atom-shell
 
-Install [atom-shell](https://github.com/atom/atom-shell) prebuilts using npm
+Install [atom-shell](https://github.com/atom/atom-shell) prebuilt binaries for command-line use using npm. Works on Mac, Windows and Linux.
+
+Atom Shell is a javascript runtime that bundles Node.js and Chromium. You use it similar to the `node` command on the command line for executing javascript programs. This module helps you easily install the `atom-shell` command for use on the command line without having to compile anything.
+
+## Installation
+
+Download and install the latest build of atom-shell for your OS and symlink it into your PATH:
 
 ```
 npm install -g atom-shell
-atom-shell # will open atom shell
-```
\ No newline at end of file
+```
+
+If that command fails with an `EACCESS` error you may have to run it again with `sudo`:
+
+```
+sudo npm install -g atom-shell
+```
+
+Now you can just run `atom-shell` to run atom-shell:
+
+```
+atom-shell
+```
+
+## Usage
+
+First you have to [write an atom shell application](https://github.com/atom/atom-shell/blob/master/docs/tutorial/quick-start.md#write-your-first-atom-shell-app)
+
+Then you can run your app using:
+
+```
+atom-shell your-app/
+```