update docs

README.md

@@ -4,15 +4,12 @@
   </a>
 </p> -->
 
-# @sigil/vinyl
-
-Virtual file format.
+# [@sigil/vinyl](./sigil) Virtual file format
 
 Note: This is an experimental fork of the gulp team's [vinyl](https://github.com/gulpjs/vinyl) package
 
 [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Azure Pipelines Build Status][azure-pipelines-image]][azure-pipelines-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
 
-
 ## What is Vinyl?
 
 Vinyl is a very simple metadata object that describes a file. When you think of a file, two attributes come to mind: `path` and `contents`. These are the main attributes on a Vinyl object. A file does not necessarily represent something on your computer’s file system. You have files on S3, FTP, Dropbox, Box, CloudThingly.io and other services. Vinyl can be used to describe files from all of these sources.

package.json

@@ -1,17 +1,17 @@
 {
   "name": "@sigil/vinyl",
-  "version": "3.1.0-0",
+  "version": "3.0.1-sigil-1",
   "description": "Virtual file format.",
   "author": "Gulp Team <team@gulpjs.com> (https://gulpjs.com/)",
   "contributors": [
     "Eric Schoffstall <yo@contra.io>",
     "Blaine Bublitz <blaine.bublitz@gmail.com>",
-    "Burt Harris"
+    "Burt Harris (sigil branch)"
   ],
   "repository": "burtharris/vinyl",
   "license": "MIT",
   "engines": {
-    "node": ">= 14.17.0"
+    "node": ">= 12"
   },
   "main": "index.js",
   "files": [

sigil.md

@@ -0,0 +1,15 @@
+# The @sigil branch
+
+This @sigil branch drops support and testing of versions of the Node.js enviornment that have passed their prime.  This allows advanced features, for example *asynchronous iterators*, which encourages innovation, and moves twoard a model of streams that can support both Node streams, and whatwg streams for modern browsers.
+
+## Background
+
+The Gulp team has produced some high quality software, this package among them.   They work hard
+to maintain a stable API, including the ability to run gulp on some quite old versions of node.  Maintaining compatabiity old versions of node comes at a cost however.
+
+The JavaScript ecosystem is currently
+in a state of rapid change state.  The @sigil branch takes operates from a somewhat different philophy:     Node, and V8 have been evolving quickly, adding features programmers want to use.  @sigil will adopt node's [release model](https://nodejs.org/en/about/releases/) that certain designated versions of Node.js are designated "long-term support" for a limited period of time, generally 30 months.   Producion applications should use only *Active LTS* or *Maintenance LTS* releases.
+
+![Active LTS](https://raw.githubusercontent.com/nodejs/Release/master/schedule.svg?sanitize=true)
+
+At the time of this writing in May 2021, Node.js 10 is reaching the end of its maintenance support.   And the sigil branch will not be tested against such older releases.