Skip to content

Commit

Permalink
add travis, standard, and a readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zeke committed Aug 31, 2016
1 parent bafafd6 commit 59e3a50
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
language: node_js
node_js:
- "4"
- "6"
1 change: 0 additions & 1 deletion build.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
const fs = require('fs')
const path = require('path')
const Datauri = require('datauri').sync
const yaml = require('yamljs')
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -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"
Expand Down
57 changes: 57 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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)_

0 comments on commit 59e3a50

Please sign in to comment.