chore: update markdown docs and tweak travis setup

Author: sbekrin

.github/npmkit-logo.svg

@@ -2,7 +2,6 @@ language: node_js
 node_js:
   - 8
 os:
-  - linux
   - osx
 before_cache:
   - rm -rf $HOME/.cache/electron-builder/wine
@@ -12,19 +11,20 @@ cache:
     - $HOME/.cache/electron
     - $HOME/.cache/electron-builder
     - $HOME/.npm/_prebuilds
+before_install:
+  - yarn global add greenkeeper-lockfile@1
 install:
   - yarn
+before_script:
+  - greenkeeper-lockfile-update
 script:
   - yarn run lint
   - yarn run pack
   - yarn run test
+after_script:
+  - greenkeeper-lockfile-upload
 after_success:
-  - if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_BRANCH" == "master" ]]; then
-      yarn release --linux;
-    fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" && "$TRAVIS_BRANCH" == "master" ]]; then
-      yarn release --mac --win;
-    fi
+  - $TRAVIS_BRANCH == "master" && yarn release --mac --win --linux
 after_failure:
   - yarn run create-diff-report
 branches:

.travis.yml

@@ -0,0 +1,23 @@
+# Contributing to `npmkit`
+
+## Pre-requiremenets
+
+Make sure you have next tools available:
+
+* Node 8.x
+* yarn
+
+## Quick Start
+
+1.  [Fork the project](https://github.com/sergeybekrin/npmkit#fork-destination-box)
+2.  Clone it: `git clone [email protected]:YOUR_USERNAME/npmkit.git`
+3.  Create new branch with helpful name: `git checkout -b fix/some-awesome-fix`
+4.  Run `yarn install`
+5.  Make your changes
+6.  Run `yarn test` to test your changes
+7.  Commit your changes with
+    [Angular commit message convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/README.md#commit-message-format),
+    e.g. `fix: some bugfix`
+8.  Push to your branch: `git push -u origin new-branch-name`
+9.  [Create a pull-request](https://github.com/sergeybekrin/npmkit/compare?expand=1)
+10. You're all set! ✨

contributing.md

@@ -0,0 +1,18 @@
+The MIT License (MIT) Copyright (c) 2016-present Sergey Bekrin
+
+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.

license.md

@@ -1,7 +1,26 @@
-# npmkit
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sergeybekrin/npmkit/master/.github/npmkit-icon.svg?sanitize=true" height="64" />
+  <h3 align="center">npmkit</h3>
+  <p align="center">A cross-platform tray app for boosting development productivity</p>
+  <p align="center">
+    <a href="https://travis-ci.org/sergeybekrin/npmkit.svg">
+      <img src="https://img.shields.io/travis/sergeybekrin/npmkit.svg" alt="Travis Build Status" />
+    </a>
+    <a href="https://github.com/sergeybekrin/npmkit/blob/master/license.md">
+      <img src="https://img.shields.io/github/license/sergeybekrin/npmkit.svg?maxAge=2592000" alt="License" />
+    </a>
+  </p>
+</p>
 
-npmkit is a cross-platform tray app for boosting your development productiviy.
+## Download npmkit
+
+Check latest release at
+[releases page](https://github.com/sergeybekrin/npmkit/releases).
+
+## Contributing
+
+See the [contribution guide](./contributing.md).
 
 ## License
 
-MIT &copy; Sergey Bekrin
+MIT &copy; [Sergey Bekrin](http://bekrin.me).