From 59e3a507ba1bdbbada26175862d20b5a71ec877e Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 31 Aug 2016 13:58:33 -0700 Subject: [PATCH] add travis, standard, and a readme --- .travis.yml | 4 ++++ build.js | 1 - package.json | 3 ++- readme.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 63 insertions(+), 2 deletions(-) create mode 100644 .travis.yml create mode 100644 readme.md diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000000..b29cf66a2b3 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,4 @@ +language: node_js +node_js: + - "4" + - "6" diff --git a/build.js b/build.js index 65f6bcb2ddf..ed1c08f912f 100644 --- a/build.js +++ b/build.js @@ -1,4 +1,3 @@ -const fs = require('fs') const path = require('path') const Datauri = require('datauri').sync const yaml = require('yamljs') diff --git a/package.json b/package.json index dd7f967f578..12e4cd6f77a 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "scripts": { "build": "node build.js > index.json", "pretest": "npm run build", - "test": "node test.js | tap-spec" + "test": "node test.js | tap-spec && standard && standard-markdown" }, "repository": "https://github.com/zeke/electron-apps", "keywords": [ @@ -26,6 +26,7 @@ "datauri": "^1.0.4", "path-exists": "^3.0.0", "standard": "^8.0.0", + "standard-markdown": "^1.2.1", "tap-spec": "^4.1.1", "tape": "^4.6.0", "yamljs": "^0.2.8" diff --git a/readme.md b/readme.md new file mode 100644 index 00000000000..3c4223fcacf --- /dev/null +++ b/readme.md @@ -0,0 +1,57 @@ +# electron-apps [![Build Status](https://travis-ci.org/zeke/elecron-apps.svg?branch=master)](https://travis-ci.org/zeke/elecron-apps) + +A collection of apps built on Electron + +## Installation + +```sh +npm install electron-apps --save +``` + +## Usage + +```js +const apps = require('electron-apps') +``` + +The module exports an array of objects. Each object looks like this: + +```js +{ + name: 'Visual Studio Code', + description: 'Open source code editor developed by Microsoft', + website: 'https://code.visualstudio.com', + repository: '', + keywords: [], + license: 'MIT', + icon: 'vscode.png', + datauri: 'data:image/png;base64,iVBOR...' +} +``` + +## Tests + +```sh +npm install +npm test +``` + +## Dependencies + +None + +## Dev Dependencies + +- [datauri](https://github.com/heldr/datauri): Create DataURI scheme easily +- [path-exists](https://github.com/sindresorhus/path-exists): Check if a path exists +- [standard](https://github.com/feross/standard): JavaScript Standard Style +- [tap-spec](https://github.com/scottcorgan/tap-spec): Formatted TAP output like Mocha's spec reporter +- [tape](https://github.com/substack/tape): tap-producing test harness for node and browsers +- [yamljs](https://github.com/jeremyfa/yaml.js): Standalone JavaScript YAML 1.2 Parser & Encoder. Works under node.js and all major browsers. Also brings command line YAML/JSON conversion tools. + + +## License + +MIT + +_Generated by [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_