From 61cd67c51ca89aa1a674da6ecd626fb3fe8722b8 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Mon, 30 Oct 2017 10:31:15 -0600 Subject: [PATCH] Begin README Hopefully coding it along the way helps it not feel like such a big task. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a5b5cbe..da7eb59 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,9 @@ [![Master Branch Build Status](https://img.shields.io/travis/elpete/hyper/master.svg?style=flat-square&label=master)](https://travis-ci.org/elpete/hyper) -## A ColdBox HTTP Builder \ No newline at end of file +## A CFML HTTP Builder + +### Inspiration + +Hyper was built after coding several API SDK's for various platforms — [S3SDK](https://github.com/coldbox-modules/s3sdk), [cbstripe](https://github.com/coldbox-modules/cbox-stripe), and [cbgithub](https://github.com/elpete/cbgithub), to name a few. I noticed that I spent a lot of time setting up the plumbing for the requests and a wrapper around `cfhttp`. Each implementation was mostly the same but slightly different. It was additionally frustrating because I really only needed to tweak a few values, usually just the `Authorization` header. It would be nice to create an HTTP client pre-configured for each of these SDK's. It seemed the perfect fit for a module. +