From 295720094d4ba5db9724edd1c4f9c402750ea88a Mon Sep 17 00:00:00 2001
From: Phil Kunz <gitlab@philkunz.com>
Date: Sun, 29 Jan 2017 01:21:48 +0100
Subject: [PATCH] improve README

---
 .gitlab-ci.yml | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md      | 43 ++++++++++++++++++++++++++++++++++++
 tslint.json    |  3 +++
 3 files changed, 105 insertions(+)
 create mode 100644 .gitlab-ci.yml
 create mode 100644 README.md
 create mode 100644 tslint.json

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000..72d25cc
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,59 @@
+image: hosttoday/ht-docker-node:npmts
+
+stages:
+- test
+- release
+- trigger
+- pages
+
+testLEGACY:
+  stage: test
+  script:
+    - npmci test legacy
+  tags:
+    - docker
+  allow_failure: true
+
+testLTS:
+  stage: test
+  script:
+    - npmci test lts
+  tags:
+    - docker
+    
+testSTABLE:
+  stage: test
+  script:
+    - npmci test stable
+  tags:
+    - docker
+
+release:
+  stage: release
+  script:
+    - npmci publish
+  only:
+    - tags
+  tags:
+    - docker
+
+trigger:
+  stage: trigger
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: pages
+  script:
+    - npmci command npmpage --publish gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..071e0e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# smartrequest
+dropin replacement for request
+
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartrequest)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartrequest)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartrequest)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartrequest/)
+
+## Status for master
+[![build status](https://GitLab.com/pushrocks/smartrequest/badges/master/build.svg)](https://GitLab.com/pushrocks/smartrequest/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartrequest/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/smartrequest.svg)](https://www.npmjs.com/package/smartrequest)
+[![Dependency Status](https://david-dm.org/pushrocks/smartrequest.svg)](https://david-dm.org/pushrocks/smartrequest)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartrequest/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartrequest/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/smartrequest/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartrequest)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+## Usage
+Use TypeScript for best in class instellisense.
+
+```javascript
+import * as smartrequest from 'smartrequest'
+
+// simple post
+let options: smartreqest.ISmartRequestOptions = { // typed options
+    headers: {
+        "Content-Type": "application/json"
+        "Authorization": "Bearer token"
+    },
+    requestBody: {
+        key1: 'value1',
+        key2: 3
+    }
+}
+
+smartrequest.post('https://example.com', options)
+
+```
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
diff --git a/tslint.json b/tslint.json
new file mode 100644
index 0000000..45052ad
--- /dev/null
+++ b/tslint.json
@@ -0,0 +1,3 @@
+{
+    "extends": "tslint-config-standard"
+}