Added publish materials

Author: cjhoward92

.npmignore

@@ -1,3 +1,2 @@
 # Test directories
 test
-build/test

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Axosoft, LLC
+
+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.

README.md

@@ -1 +1,49 @@
-nodegit-lfs
+# NodeGit LFS
+
+Nodegit LFS is an extension library used to augment [NodeGit](http://www.nodegit.org/) with the capability to use [git lfs](https://git-lfs.github.com/) via the command line.
+
+To use this package, you must have [git](https://git-scm.com/) and [git lfs](https://git-lfs.github.com/) installed.
+
+This project is new, and is highly volatile. It should be noted that any subsequesnt releases may have breaking changes for the foreseeable future.
+
+## How to get started
+
+`NodeGit` is a peer dependency of the `NodeGit LFS` package, so you should make sure to install `NodeGit` before `NodeGit LFS`.
+
+To install `NodeGit` run:
+
+`yarn add nodegit`
+
+To install `NodeGit LFS` run:
+
+`yarn add nodegit-lfs`
+
+Once installed, you only need to bootstrap `NodeGit LFS` once:
+
+```javascript
+const nodegit = require('nodegit');
+const addLfs = require('nodegit-lfs');
+
+// Call the function returned from nodegit-lfs with nodegit as a parameter
+// and you are good to go!
+addLfs(nodegit);
+
+// After nodegit has been augmented you can use LFS via the LFS object
+nodegit.LFS.register()
+  .then(() => {
+    console.log('The LFS filter has been registered!');
+  });
+```
+
+## Building from source
+
+Clone the repo:
+
+`git clone https://github.com/axosoft/nodegit-lfs`
+
+Once cloned:
+
+```
+cd nodegit-lfs
+yarn
+```

package.json

@@ -9,7 +9,7 @@
     "eslint": "\"node_modules/.bin/eslint\" src test/tests",
     "eslint-quick-fix": "\"node_modules/.bin/eslint\" src test/tests --fix",
     "pretest": "yarn eslint",
-    "postinstall": "yarn compile",
+    "prepublish": "yarn eslint && yarn compile",
     "src-watch": "\"node_modules/.bin/babel\" src -d build/src -w",
     "test": "nyc mocha --compilers js:babel-core/register --expose-gc test/runner \"test/**/*.spec.js\"",
     "test-debug": "mocha --debug-brk --compilers js:babel-core/register --expose-gc test/runner \"test/**/*.spec.js\"",
@@ -24,10 +24,9 @@
     "lfs",
     "nodegit"
   ],
-  "directories": {
-    "build": "./build",
-    "test": "./test/tests"
-  },
+  "files": [
+    "build/src"
+  ],
   "bugs": {
     "url": "https://github.com/Axosoft/nodegit-lfs/issues"
   },