Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add MIT license.

  • Loading branch information...
commit b40736d97100384fab338f1efaf268a71620d9a4 1 parent fb686b3
Nathan Rajlich authored
Showing with 37 additions and 7 deletions.
  1. +22 −0 LICENSE
  2. +15 −7 README.md
22 LICENSE
View
@@ -0,0 +1,22 @@
+ Copyright (c) 2010 Nathan Rajlich
+
+ 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.
22 README.md
View
@@ -3,17 +3,22 @@ node-applescript
A high-level way to execute AppleScript code through NodeJS, and retrieve
the result as a native JavaScript object (when possible). In reality, this
-module is just a simple wrapper around the Apple `osascript` command.
+module is just a simple wrapper around the OS X `osascript` command.
### Why?
AppleScripts are the only way to communicate and interact with certain
external OS X processes, for example [iTunes](http://www.itunes.com).
+Easy Install
+------------
+
+ npm install applescript
+
Requirements
------------
* Mac (or Hackintosh) running [OS X](http://www.apple.com/macosx) (tested with Snow Leopard)
- * [NodeJS](http://nodejs.org) (v0.1.100 or newer)
+ * [NodeJS](http://nodejs.org) (v0.2.0 or newer)
Usage
-----
@@ -21,8 +26,6 @@ Usage
The `node-applescript` module provides `execString` and `execFile` functions
to easily execute AppleScript commands and buffer the output into a calback.
---------------------------------------------------------
-
var applescript = require("node-applescript");
// Very basic AppleScript command. Returns the song name of each
@@ -40,7 +43,12 @@ to easily execute AppleScript commands and buffer the output into a calback.
}
});
---------------------------------------------------------
-
`execFile` works the exact same way, except you pass the _path_ of the AppleScript
-(`*.applescript`) file as the first argument instead of the command itself.
+(`*.applescript`) file as the first argument instead of the command itself, and you
+may pass an optional Array of String arguments to send to the applescript file.
+
+Licence
+-------
+
+The `node-applescript` module is licensed under the MIT license, of course!
+
Please sign in to comment.
Something went wrong with that request. Please try again.