From 6bc7edceb98c81be633480d15e74435ce867a96e Mon Sep 17 00:00:00 2001
From: Phil Kunz <gitlab@philkunz.com>
Date: Sun, 29 Jan 2017 18:22:17 +0100
Subject: [PATCH] update README

---
 README.md    | 56 +++++++++++++++++++++++++++++++++-------------------
 package.json | 10 +++++-----
 2 files changed, 41 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index dc03e00..105a088 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,47 @@
 # cflare
-allows you to manage multiple cloudflare accounts.
+easy cloudflare management
 
-> Note: this package is still in alpha, so some things do not yet work.
-I (Phil from Lossless) expect this package to be ready 1. of June 2016.
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/cflare)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/cflare)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/cflare)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/cflare/)
 
-## Status
-[![Build Status](https://travis-ci.org/pushrocks/cflare.svg?branch=master)](https://travis-ci.org/pushrocks/cflare)
+## Status for master
+[![build status](https://GitLab.com/pushrocks/cflare/badges/master/build.svg)](https://GitLab.com/pushrocks/cflare/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/cflare/badges/master/coverage.svg)](https://GitLab.com/pushrocks/cflare/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/cflare.svg)](https://www.npmjs.com/package/cflare)
+[![Dependency Status](https://david-dm.org/pushrocks/cflare.svg)](https://david-dm.org/pushrocks/cflare)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/cflare/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/cflare/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/cflare/badges/code.svg)](https://www.bithound.io/github/pushrocks/cflare)
+[![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
-var cflare = require("cflare");
-var cflareInstance = new cflare();
+import * as cflare from 'cflare'
 
-cflareInstance.auth({
-    email:"",
-    key:""
-});
+let myCflareAccount = new cflare.CflareAccount()
+testCflareAccount.auth({
+    email: 'someuser@example.com',
+    key: 'someLongApiKey'
+})
+
+let myAsyncCflareManagement = async () => {
+    // get things
+    let myZones = await myCflareAccount.listZones() // zones are fully typed
+    let myIdForADomain = await myCflareAccount.getZoneId('example.com') // type number
+    let myRecordsForADomain = await myCflareAccount.listRecords('example.com') // records are fully typed
+
+    // set things
+    myCflareAccount.updateRecord(...)
+    myCflareAccount.createRecord(...)
+    myCflareAccount.deleteRecord(...)
+}
 
-cflareInstance.createRecord(); // returns promise with resolve function getting the response;
-cflareInstance.removeRecord(); // returns promise with resolve function getting the response;
-cflareInstance.copyRecord(); // returns promise with resolve function getting the response;
-cflareInstance.listRecords(); // returns promise with resolve function getting the response;
-cflareInstance.listDomains(); // returns promise with resolve function getting the response;
 ```
 
-### About the authors:
-[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
-
-[![Gitter](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)
\ No newline at end of file
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
diff --git a/package.json b/package.json
index b5981d7..02824ef 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "cflare",
   "version": "0.0.17",
-  "description": "cloudflare management for CoreOS",
+  "description": "easy cloudflare management",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
@@ -9,18 +9,18 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pushrocks/cflare.git"
+    "url": "git+https://gitlab.com/pushrocks/cflare.git"
   },
   "keywords": [
-    "CoreOS",
+    "Push.Rocks",
     "cloudflare"
   ],
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/cflare/issues"
+    "url": "https://gitlab.com/pushrocks/cflare/issues"
   },
-  "homepage": "https://github.com/pushrocks/cflare#readme",
+  "homepage": "https://gitlab.com/pushrocks/cflare#readme",
   "dependencies": {
     "beautylog": "^6.1.1",
     "smartdelay": "^1.0.1",