diff --git a/README.md b/README.md new file mode 100644 index 0000000..e474583 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# BittMapp - A monochrome bitmap editor + +A small browser-based tool for creating and editing black and white (monochrome) bitmaps. + +### Building + +Node.js v8.9.1+ required. + +```bash +npm install && npm run build +``` + +Then open index.html in your browser of choice. \ No newline at end of file diff --git a/package.json b/package.json index 07fa868..4370016 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,15 @@ { "name": "bittmapp", "version": "0.0.1", - "description": "BittMapp - A bitmap image editor", + "description": "BittMapp - A monochrome bitmap editor", "scripts": { "build": "tsc" }, "author": "Nathan Kunicki ", "license": "MIT", + "engines": { + "node" : ">=8.9.1" + }, "devDependencies": { "typescript": "^2.6.1" }