From e841831f679c655ab262528e2c5e530335573a4f Mon Sep 17 00:00:00 2001 From: Tom Boutell Date: Mon, 18 Jun 2018 08:07:18 -0400 Subject: [PATCH] Suggested language acknowledging shelljs as a reasonable "production" application of the module --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5e364c1..cf4228b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Make synchronous web requests with cross platform support. # **N.B.** You should **not** be using this in a production application. In a node.js application you will find that you are completely unable to scale your server. In a client application you will find that sync-request causes the app to hang/freeze. Synchronous web requests are the number one cause of browser crashes. For production apps, you should use [then-request](https://github.com/then/then-request), which is exactly the same except that it is asynchronous. +### Production use in conjunction with shelljs is reasonable because shelljs is typically used to write short, synchronous command line scripts. But it *never* makes sense to to use this module in a web app, REST server, socket.io server, etc. + [![Build Status](https://img.shields.io/travis/ForbesLindesay/sync-request/master.svg)](https://travis-ci.org/ForbesLindesay/sync-request) [![Dependency Status](https://img.shields.io/david/ForbesLindesay/sync-request.svg)](https://david-dm.org/ForbesLindesay/sync-request) [![NPM version](https://img.shields.io/npm/v/sync-request.svg)](https://www.npmjs.org/package/sync-request)