Update docs

thebespokepixel · Aug 14, 2019 · afa86e6 · afa86e6
1 parent f22498f
commit afa86e6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 16 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -115,7 +115,7 @@ <h3 class="m0 no-anchor">truwrap</h3>
         </div>
         <div class="badges"><p><p><a href="https://github.com/thebespokepixel/truwrap" title="Github"><img src="https://img.shields.io/badge/github-source-4E73B6" alt="Github"></a> <a href="https://travis-ci.org/thebespokepixel/truwrap" title="Travis"><img src="https://img.shields.io/travis/thebespokepixel/truwrap/master?logo=travis" alt="Travis"></a> <br>
 </p> <p><a href="https://codeclimate.com/github/thebespokepixel/truwrap/maintainability" title="Code-climate"><img src="https://api.codeclimate.com/v1/badges/5732d1aad01d74b6ef4a/maintainability" alt="Code-climate"></a> <a href="https://codeclimate.com/github/thebespokepixel/truwrap/test_coverage" title="Coverage"><img src="https://api.codeclimate.com/v1/badges/5732d1aad01d74b6ef4a/test_coverage" alt="Coverage"></a> <br>
-</p> <p><a href="https://david-dm.org/thebespokepixel/truwrap/master" title="David"><img src="https://david-dm.org/thebespokepixel/truwrap/master/status.svg" alt="David"></a> <br>
+</p> <p><a href="https://snyk.io/test/github/thebespokepixel/truwrap" title="Snyk"><img src="https://snyk.io/test/github/thebespokepixel/truwrap/badge.svg" alt="Snyk"></a> <a href="https://david-dm.org/thebespokepixel/truwrap/master" title="David"><img src="https://david-dm.org/thebespokepixel/truwrap/master/status.svg" alt="David"></a> <br>
 </p> <br>
 </p></div>
         <div class="mt1 h6 quiet">
@@ -220,7 +220,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
     </h3>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L50-L218'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L50-L218'>
       <span>src/index.js</span>
       </a>
 
@@ -383,7 +383,7 @@ <h3 class='left m0 panel-title' id='api'>
     </h3>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L100-L167'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L100-L167'>
       <span>src/index.js</span>
       </a>
 
@@ -432,7 +432,7 @@ <h3 class='left m0 panel-title' id='api'>
   <div class='clearfix'>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L107-L113'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L107-L113'>
       <span>src/index.js</span>
       </a>
 
@@ -495,7 +495,7 @@ <h3 class='left m0 panel-title' id='api'>
   <div class='clearfix'>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L119-L119'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L119-L119'>
       <span>src/index.js</span>
       </a>
 
@@ -558,7 +558,7 @@ <h3 class='left m0 panel-title' id='api'>
   <div class='clearfix'>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L128-L134'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L128-L134'>
       <span>src/index.js</span>
       </a>
 
@@ -644,7 +644,7 @@ <h3 class='left m0 panel-title' id='api'>
   <div class='clearfix'>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L142-L145'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L142-L145'>
       <span>src/index.js</span>
       </a>
 
@@ -722,7 +722,7 @@ <h3 class='left m0 panel-title' id='api'>
   <div class='clearfix'>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L152-L155'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L152-L155'>
       <span>src/index.js</span>
       </a>
 
@@ -785,7 +785,7 @@ <h3 class='left m0 panel-title' id='api'>
   <div class='clearfix'>
 
 
-      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/939000b9b3b00581ac34da5343acbad710632583/src/index.js#L163-L166'>
+      <a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/f22498f66236dbb62427de9848bc295cc089eb28/src/index.js#L163-L166'>
       <span>src/index.js</span>
       </a>
 

diff --git a/readme.md b/readme.md
@@ -2,18 +2,20 @@
 
 > A node module and CLI for text wrapping, panels & tables that supports 24bit color SGR codes.
 
-##### Status
+##### Publishing Status
 
-[![npm](https://img.shields.io/npm/v/truwrap?logo=npm)](https://www.npmjs.com/package/truwrap "npm") [![Travis](https://img.shields.io/travis/thebespokepixel/truwrap/master?logo=travis)](https://travis-ci.org/thebespokepixel/truwrap "Travis") [![David](https://david-dm.org/thebespokepixel/truwrap/master/status.svg)](https://david-dm.org/thebespokepixel/truwrap/master "David")  
- [![Code-climate](https://api.codeclimate.com/v1/badges/5732d1aad01d74b6ef4a/maintainability)](https://codeclimate.com/github/thebespokepixel/truwrap/maintainability "Code-climate") [![Coverage](https://api.codeclimate.com/v1/badges/5732d1aad01d74b6ef4a/test_coverage)](https://codeclimate.com/github/thebespokepixel/truwrap/test_coverage "Coverage") [![Snyk](https://snyk.io/test/github/thebespokepixel/truwrap/badge.svg)](https://snyk.io/test/github/thebespokepixel/truwrap "Snyk")   
+[![npm](https://img.shields.io/npm/v/truwrap?logo=npm)](https://www.npmjs.com/package/truwrap "npm") [![David](https://david-dm.org/thebespokepixel/truwrap/master/status.svg)](https://david-dm.org/thebespokepixel/truwrap/master "David")  
+ [![Travis](https://img.shields.io/travis/com/thebespokepixel/truwrap/master?logo=travis)](https://travis-ci.com/thebespokepixel/truwrap "Travis") [![Rollup](https://img.shields.io/badge/es6-module%3Amjs_%E2%9C%94-64CA39?&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNCIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDE0IDE0Ij4KICA8ZyBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgPHBhdGggZmlsbD0iI0ZGMzMzMyIgZD0iTTEwLjkwNDI4MjQsMy4wMDkxMDY4MyBDMTEuMjM4NzA1NSwzLjU4MjgzNzEzIDExLjQyODU3MTQsNC4yNDQ4MzM2MyAxMS40Mjg1NzE0LDQuOTUwOTYzMjIgQzExLjQyODU3MTQsNi40MTc4NjM0IDEwLjYwODY5NTcsNy42OTU2MjE3MiA5LjM5MTgyNzM5LDguMzc2NTMyNCBDOS4zMDU1MjQ2OCw4LjQyNDg2ODY1IDkuMjczMTYxMTYsOC41MzIwNDkwNCA5LjMxODQ3MDA5LDguNjE4MjEzNjYgTDExLjQyODU3MTQsMTMgTDUuMjU4NjgyODEsMTMgTDIuMzM5Nzc3MjMsMTMgQzIuMTUyMTIzNDUsMTMgMiwxMi44NDgyNzU3IDIsMTIuNjUzODA0OCBMMiwxLjM0NjE5NTIyIEMyLDEuMTU0OTk2ODggMi4xNDgzMTU0MywxIDIuMzM5Nzc3MjMsMSBMNy42NjAyMjI3NywxIEM3LjcwMTU0MTQ5LDEgNy43NDExMzc2NCwxLjAwNzM1NTg4IDcuNzc3NzY2NTgsMS4wMjA5MDQyOSBDOS4wNjQ1MzgyOCwxLjE0NDU0MDA0IDEwLjE3MzM4ODQsMS44NTM4NTI5MSAxMC44MjIyOTQ5LDIuODcyNTA0MzggQzEwLjc5OTE5NTMsMi44NDQ4NDgwNiAxMC44NDQ0OTkxLDIuOTQ5MTc0NzYgMTAuOTA0MjgyNCwzLjAwOTEwNjgzIFoiLz4KICAgIDxwYXRoIGZpbGw9IiMwMDAwMDAiIGZpbGwtb3BhY2l0eT0iLjMxIiBkPSJNOC44NTcxNDI4NiwzLjU3MTQyODU3IEw2LjcxNDI4NTcxLDYuNTcxNDI4NTcgTDkuMjg1NzE0MjksNS4yODU3MTQyOSBDOS4yODU3MTQyOSw1LjI4NTcxNDI5IDkuNzE0Mjg1NzEsNC44NTcxNDI4NiA5LjI4NTcxNDI5LDQuNDI4NTcxNDMgQzkuMjg1NzE0MjksNCA4Ljg1NzE0Mjg2LDMuNTcxNDI4NTcgOC44NTcxNDI4NiwzLjU3MTQyODU3IFoiLz4KICAgIDxwYXRoIGZpbGw9IiNGQkIwNDAiIGQ9Ik0yLjg0Njc0NjAzLDEyLjk5NTg0OTUgQzMuMjY0OTIwNjIsMTIuOTk1ODQ5NSAzLjE4NTkzMDM0LDEyLjk0NjM2NjkgMy4zMTYxMTYzOCwxMi44NzM5MDU0IEMzLjYxODE3NTg3LDEyLjcwNTc3OTMgNS42ODk0NDA5OSw4LjcxMjc4NDU5IDcuNzE3NTU0NzYsNi44MjEzNjYwMiBDOS43NDU2Njg1Miw0LjkyOTk0NzQ2IDEwLjAwNDU3NjcsNS41NjA0MjAzMiA4Ljg4NDc5ODk1LDMuNTAyOTc3MjMgQzguODg0Nzk4OTUsMy41MDI5NzcyMyA5Ljc0NzgyNjA5LDUuMTQyMjA2NjUgOS4wMTQyNTMwMiw1LjI2ODMwMTIzIEM4LjQzODE4MjQxLDUuMzY3MDc1MzEgNy4xMTk5MDg0Nyw0LjEyMjk0MjIxIDcuNjExODMzOTMsMy4wMDQ5MDM2OCBDOC4wOTA4MTM5OSwxLjkxNDE4NTY0IDEwLjAxOTY3OTYsMi4xMjAxNDAxMSAxMC45MDY0NCwzLjAwOTEwNjgzIEMxMC44NzgzOTE2LDIuOTYyODcyMTUgMTAuODUwMzQzMiwyLjkxNjYzNzQ4IDEwLjgyMjI5NDksMi44NzI1MDQzOCBDMTAuMzA0NDc4NiwyLjI1MjUzOTQgOS41MDQwMjA5MiwxLjkwMzY3Nzc2IDguNzEwMDM1OTYsMS45MDM2Nzc3NiBDNy4xOTk3Mzg0OCwxLjkwMzY3Nzc2IDYuODIwMDA2NTQsMi40MjY5NzAyMyAzLjkyMDIzNTM3LDcuNjE5OTY0OTcgQzIuMzg3Nzk5MzQsMTAuMzY1NDA2NyAyLjAxMDgzMTkzLDExLjU3MzUwNzkgMi4wMDYyOTA2OSwxMi4xNjk4MTgyIEMyLDEyLjk5NTg0OTUgMi4wMDYyOTA2OSwxMi45OTU4NDk1IDIuODQ2NzQ2MDMsMTIuOTk1ODQ5NSBaIi8%2BCiAgPC9nPgo8L3N2Zz4K)](https://github.com/rollup/rollup/wiki/pkg.module "Rollup")   
 
-##### Developer
+##### Development Status
 
-[![Greenkeeper](https://badges.greenkeeper.io/thebespokepixel/truwrap.svg)](https://greenkeeper.io/ "Greenkeeper") [![David](https://david-dm.org/thebespokepixel/truwrap/develop/status.svg)](https://david-dm.org/thebespokepixel/truwrap/develop "David") [![Rollup](https://img.shields.io/badge/es6-module%3Amjs_%E2%9C%94-64CA39?&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNCIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDE0IDE0Ij4KICA8ZyBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgPHBhdGggZmlsbD0iI0ZGMzMzMyIgZD0iTTEwLjkwNDI4MjQsMy4wMDkxMDY4MyBDMTEuMjM4NzA1NSwzLjU4MjgzNzEzIDExLjQyODU3MTQsNC4yNDQ4MzM2MyAxMS40Mjg1NzE0LDQuOTUwOTYzMjIgQzExLjQyODU3MTQsNi40MTc4NjM0IDEwLjYwODY5NTcsNy42OTU2MjE3MiA5LjM5MTgyNzM5LDguMzc2NTMyNCBDOS4zMDU1MjQ2OCw4LjQyNDg2ODY1IDkuMjczMTYxMTYsOC41MzIwNDkwNCA5LjMxODQ3MDA5LDguNjE4MjEzNjYgTDExLjQyODU3MTQsMTMgTDUuMjU4NjgyODEsMTMgTDIuMzM5Nzc3MjMsMTMgQzIuMTUyMTIzNDUsMTMgMiwxMi44NDgyNzU3IDIsMTIuNjUzODA0OCBMMiwxLjM0NjE5NTIyIEMyLDEuMTU0OTk2ODggMi4xNDgzMTU0MywxIDIuMzM5Nzc3MjMsMSBMNy42NjAyMjI3NywxIEM3LjcwMTU0MTQ5LDEgNy43NDExMzc2NCwxLjAwNzM1NTg4IDcuNzc3NzY2NTgsMS4wMjA5MDQyOSBDOS4wNjQ1MzgyOCwxLjE0NDU0MDA0IDEwLjE3MzM4ODQsMS44NTM4NTI5MSAxMC44MjIyOTQ5LDIuODcyNTA0MzggQzEwLjc5OTE5NTMsMi44NDQ4NDgwNiAxMC44NDQ0OTkxLDIuOTQ5MTc0NzYgMTAuOTA0MjgyNCwzLjAwOTEwNjgzIFoiLz4KICAgIDxwYXRoIGZpbGw9IiMwMDAwMDAiIGZpbGwtb3BhY2l0eT0iLjMxIiBkPSJNOC44NTcxNDI4NiwzLjU3MTQyODU3IEw2LjcxNDI4NTcxLDYuNTcxNDI4NTcgTDkuMjg1NzE0MjksNS4yODU3MTQyOSBDOS4yODU3MTQyOSw1LjI4NTcxNDI5IDkuNzE0Mjg1NzEsNC44NTcxNDI4NiA5LjI4NTcxNDI5LDQuNDI4NTcxNDMgQzkuMjg1NzE0MjksNCA4Ljg1NzE0Mjg2LDMuNTcxNDI4NTcgOC44NTcxNDI4NiwzLjU3MTQyODU3IFoiLz4KICAgIDxwYXRoIGZpbGw9IiNGQkIwNDAiIGQ9Ik0yLjg0Njc0NjAzLDEyLjk5NTg0OTUgQzMuMjY0OTIwNjIsMTIuOTk1ODQ5NSAzLjE4NTkzMDM0LDEyLjk0NjM2NjkgMy4zMTYxMTYzOCwxMi44NzM5MDU0IEMzLjYxODE3NTg3LDEyLjcwNTc3OTMgNS42ODk0NDA5OSw4LjcxMjc4NDU5IDcuNzE3NTU0NzYsNi44MjEzNjYwMiBDOS43NDU2Njg1Miw0LjkyOTk0NzQ2IDEwLjAwNDU3NjcsNS41NjA0MjAzMiA4Ljg4NDc5ODk1LDMuNTAyOTc3MjMgQzguODg0Nzk4OTUsMy41MDI5NzcyMyA5Ljc0NzgyNjA5LDUuMTQyMjA2NjUgOS4wMTQyNTMwMiw1LjI2ODMwMTIzIEM4LjQzODE4MjQxLDUuMzY3MDc1MzEgNy4xMTk5MDg0Nyw0LjEyMjk0MjIxIDcuNjExODMzOTMsMy4wMDQ5MDM2OCBDOC4wOTA4MTM5OSwxLjkxNDE4NTY0IDEwLjAxOTY3OTYsMi4xMjAxNDAxMSAxMC45MDY0NCwzLjAwOTEwNjgzIEMxMC44NzgzOTE2LDIuOTYyODcyMTUgMTAuODUwMzQzMiwyLjkxNjYzNzQ4IDEwLjgyMjI5NDksMi44NzI1MDQzOCBDMTAuMzA0NDc4NiwyLjI1MjUzOTQgOS41MDQwMjA5MiwxLjkwMzY3Nzc2IDguNzEwMDM1OTYsMS45MDM2Nzc3NiBDNy4xOTk3Mzg0OCwxLjkwMzY3Nzc2IDYuODIwMDA2NTQsMi40MjY5NzAyMyAzLjkyMDIzNTM3LDcuNjE5OTY0OTcgQzIuMzg3Nzk5MzQsMTAuMzY1NDA2NyAyLjAxMDgzMTkzLDExLjU3MzUwNzkgMi4wMDYyOTA2OSwxMi4xNjk4MTgyIEMyLDEyLjk5NTg0OTUgMi4wMDYyOTA2OSwxMi45OTU4NDk1IDIuODQ2NzQ2MDMsMTIuOTk1ODQ5NSBaIi8%2BCiAgPC9nPgo8L3N2Zz4K)](https://github.com/rollup/rollup/wiki/pkg.module "Rollup")   
+[![Greenkeeper](https://badges.greenkeeper.io/thebespokepixel/truwrap.svg)](https://greenkeeper.io/ "Greenkeeper") [![Travis](https://img.shields.io/travis/com/thebespokepixel/truwrap/develop?logo=travis)](https://travis-ci.com/thebespokepixel/truwrap "Travis")  
+ [![David](https://david-dm.org/thebespokepixel/truwrap/develop/status.svg)](https://david-dm.org/thebespokepixel/truwrap/develop "David") [![David-developer](https://david-dm.org/thebespokepixel/truwrap/develop/dev-status.svg)](https://david-dm.org/thebespokepixel/truwrap/develop?type=dev "David-developer")  
+ [![Snyk](https://snyk.io/test/github/thebespokepixel/truwrap/badge.svg)](https://snyk.io/test/github/thebespokepixel/truwrap "Snyk") [![Code-climate](https://api.codeclimate.com/v1/badges/5732d1aad01d74b6ef4a/maintainability)](https://codeclimate.com/github/thebespokepixel/truwrap/maintainability "Code-climate") [![Coverage](https://api.codeclimate.com/v1/badges/5732d1aad01d74b6ef4a/test_coverage)](https://codeclimate.com/github/thebespokepixel/truwrap/test_coverage "Coverage")   
 
-##### Help
+##### Documentation/Help
 
-[![Inch](https://inch-ci.org/github/thebespokepixel/truwrap.svg?branch=master&style=shields)](https://inch-ci.org/github/thebespokepixel/truwrap "Inch")   
+[![Inch](https://inch-ci.org/github/thebespokepixel/truwrap.svg?branch=master&style=shields)](https://inch-ci.org/github/thebespokepixel/truwrap "Inch") [![Twitter](https://img.shields.io/twitter/follow/thebespokepixel?style=social)](https://twitter.com/thebespokepixel "Twitter")   
 
 Many current tty text wrapping solutions have issues with the 'long' and currently 'non-standard' RGB SGR codes (i.e `^[[38;2;204;51;66m`). This meant that, while it's possible to have wonderful, rich, full gamut colours and the aesthetic data visualisations it entails, it comes at the price of painful typography and corrupted console displays as text is broken up, unnaturally wrapped and becoming unreadable as the SGR codes are dashed against the rocks of 1980's shortsightedness, confusing your terminal and ever so slightly breaking the heart of design aware coders and administrators everywhere.