diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/README.md b/README.md index fb6d1c0..436f7c6 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,12 @@ To install, either download the repo, or as I would recommend, use [Pathogen](ht git clone git://github.com/jaxbot/browserlink.vim.git ``` -If you haven't already, you'll need to install [Node.js](http://nodejs.org/) (Node is used to send refresh commands to your page(s)) +If you haven't already, you'll need to install [Node.js](http://nodejs.org/) +(Node is used to send refresh commands to your page(s)) and +[npm](https://www.npmjs.com) (Node Packet Manager, which manages +dependencies for Node.js apps) + +Next, navigate to where you cloned browserlink.vim and run `npm install` Lastly, you need some javascript on your page(s) to listen for the refresh commands. For this there are two options: diff --git a/package.json b/package.json new file mode 100644 index 0000000..475b0e2 --- /dev/null +++ b/package.json @@ -0,0 +1,37 @@ +{ + "name": "browserlink.vim", + "version": "2.6.0", + "description": "Live browser editing for Vim", + "main": "browserlink/browserlink.js", + "directories": { + "doc": "doc" + }, + "dependencies": { + "websocketserver":"*", + "http":"*", + "fs":"*", + "path":"*" + + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/jaxbot/browserlink.vim.git" + }, + "keywords": [ + "vim", + "html", + "css", + "js", + "php", + "nodejs" + ], + "author": "jaxbot", + "license": "MIT", + "bugs": { + "url": "https://github.com/jaxbot/browserlink.vim/issues" + }, + "homepage": "https://github.com/jaxbot/browserlink.vim#readme" +}