Skip to content

Commit

Permalink
README++
Browse files Browse the repository at this point in the history
  • Loading branch information
TooTallNate committed Sep 12, 2012
1 parent aa2081d commit 2c8a313
Showing 1 changed file with 1 addition and 12 deletions.
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ node-ffi
========
### Node.js Foreign Function Interface [![Build Status](https://secure.travis-ci.org/rbranson/node-ffi.png)](http://travis-ci.org/rbranson/node-ffi)

## Attention node-ffi users! v1.0 has been released! See the [API changes page][v1apichanges].

`node-ffi` is a Node.js addon for loading and calling dynamic libraries using
pure JavaScript. It can be used to create bindings to native libraries without
writing any C++ code.
Expand All @@ -17,7 +15,6 @@ for an example of this use case.
create situations where you will segfault the interpreter and unless you've got
C debugger skills, you probably won't know what's going on.


Example
-------

Expand All @@ -38,26 +35,20 @@ current.atoi('1234'); // 1234

For a more detailed introduction, see the [node-ffi tutorial page][tutorial].


Requirements
------------

* Linux, OS X, Windows, or Solaris.
* `libffi` comes bundled with node-ffi; it does *not* need to be installed on your system.
* The current version is tested to run on node v0.6, v0.7, and v0.8.


Installation
------------

``` bash
$ npm install ffi
```

__Note:__ When installing on Windows, you'll need to invoke `npm install ffi` from
within a [Mozilla Build](https://wiki.mozilla.org/MozillaBuild) ([direct
link](http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-Latest.exe)) command window.

Source Install / Manual Compilation
-----------------------------------

Expand All @@ -73,18 +64,16 @@ Now you can compile `node-ffi`:
``` bash
$ git clone git://github.com/rbranson/node-ffi.git
$ cd node-ffi
$ node-gyp configure build
$ node-gyp rebuild
```


Types
-----

The types that you specify in function declarations correspond to ref's types
system. So [see its docs][ref-types] for
a reference if you are unfamiliar.


V8 and 64-bit Types
-------------------

Expand Down

0 comments on commit 2c8a313

Please sign in to comment.